Network Related Interfaces
Check the ClusterIP network segment for the cluster
Description
Check the ClusterIP network segment for the cluster
Request structure
1POST /v2/net/check_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| ipVersion | String | Yes | RequestBody | Container network IP address version, options: [IPv4, IPv6, dualStack] |
| clusterIPCIDR | String | No | RequestBody | Cluster IPv4 network segment. Required when IP version is IPv4. |
| clusterIPCIDRIPv6 | String | No | RequestBody | Cluster IPv6 network segment. Required when IP version is IPv6. |
| vpcID | String | Yes | RequestBody | VPC ID |
| vpcCIDR | String | No | RequestBody | VPC IPv4 network segment. Required when IP version is IPv4. |
| vpcCIDRIPv6 | String | No | RequestBody | VPC IPv6 network segment. Required when IP version is IPv6. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| errMsg | String | No | Error message |
| isConflict | String | Yes | Conflict or not |
| requestID | String | Yes | Request ID. This ID is provided for issue localization. |
Request example
1POST /v2/net/check_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "vpcID": "vpc-pi9fghaxcpnf",
6 "vpcCIDR": "192.168.0.0/16",
7 "vpcCIDRIPv6": "",
8 "clusterIPCIDR": "172.31.0.0/16",
9 "clusterIPCIDRIPv6": "",
10 "ipVersion": "ipv4"
11}
Response example
1HTTP/1.1 200 OK
2X-Bce-Request-Id: d1b66c3d-b16f-4ff2-bedf-af21f6bcd827
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6 "isConflict": false,
7 "errMsg": "",
8 "requestID": "40165eb4-0fc7-405e-bcdf-10ba2ffc1ee3"
9}
Check cluster container network segment
Description
Check cluster container network segment
Request structure
1POST /v2/net/check_container_network_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| ipVersion | String | No | RequestBody | Container network IP address version, defaulting to IPv4, options:[IPv4, IPv6, dualStack] |
| clusterIPCIDR | String | No | RequestBody | Cluster IPv4 network segment. Required when IP version is IPv4. |
| clusterIPCIDRIPv6 | String | No | RequestBody | Cluster IPv6 network segment. Required when IP version is IPv6. |
| containerCIDR | String | No | RequestBody | Container network IPv4 network segment. Required when IP version is IPv4. |
| containerCIDRIPv6 | String | No | RequestBody | Container network IPv6 network segment. Required when IP version is IPv6. |
| maxPodsPerNode | Integer | Yes | RequestBody | Maximum number of pods per node |
| vpcID | String | Yes | RequestBody | VPC ID |
| vpcCIDR | String | No | RequestBody | VPC IPv4 network segment. Required when IP version is IPv4. |
| vpcCIDRIPv6 | String | No | RequestBody | VPC IPv6 network segment. Required when IP version is IPv6. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| clusterIPCIDRConflict | [ClusterIPCIDRConflict](CCE/API_V2 Reference/Appendix.md#ClusterIPCIDRConflict) | No | ClusterIP network segment conflict information |
| containerCIDRConflict | [ContainerCIDRConflict](CCE/API_V2 Reference/Appendix.md#ContainerCIDRConflict) | No | Container network segment conflict information |
| errMsg | String | No | Error message |
| isConflict | String | Yes | Conflict or not |
| maxNodeNum | String | Yes | Maximum node count |
| requestID | String | Yes | Request ID. This ID is provided for issue localization. |
Request example
1POST /v2/net/check_container_network_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "vpcID": "vpc-pi9fghaxcpnf",
6 "vpcCIDR": "192.168.0.0/16",
7 "vpcCIDRIPv6": "",
8 "containerCIDR": "172.28.0.0/16",
9 "containerCIDRIPv6": "",
10 "clusterIPCIDR": "172.31.0.0/16",
11 "clusterIPCIDRIPv6": "",
12 "maxPodsPerNode": 256,
13 "ipVersion": "ipv4"
14}
Response example
1HTTP/1.1 200 OK
2X-Bce-Request-Id: a2c5b12b-6005-4266-a8e8-f5b3d903a5c7
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6 "maxNodeNum": 256,
7 "isConflict": false,
8 "errMsg": "",
9 "containerCIDRConflict": null,
10 "clusterIPCIDRConflict": null,
11 "requestID": "a2c5b12b-6005-4266-a8e8-f5b3d903a5c7"
12}
Recommended ClusterIP network segment
Description
Recommended ClusterIP network segment
Request structure
1POST /v2/net/recommend_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| clusterMaxServiceNum | Integer | Yes | RequestBody | Maximum number of services in the cluster |
| ipVersion | String | No | RequestBody | Container network IP address version, defaulting to IPv4, options:[IPv4, IPv6, dualStack] |
| containerCIDR | String | No | RequestBody | Container network IPv4 network segment. Required when IP version is IPv4. |
| containerCIDRIPv6 | String | No | RequestBody | Container network IPv6 network segment. Required when IP version is IPv6. |
| privateNetCIDRs | List |
No | RequestBody | IPv4 private network address range, options [10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16] |
| privateNetCIDRIPv6s | List |
No | RequestBody | IPv6 private network address range, currently only supporting [fc00::/7] |
| vpcCIDR | String | No | RequestBody | VPC IPv4 network segment. Required when IP version is IPv4. |
| vpcCIDRIPv6 | String | No | RequestBody | VPC IPv6 network segment. Required when IP version is IPv6. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| errMsg | String | No | Error message |
| isSuccess | Boolean | Yes | Whether the request succeeded |
| recommendedClusterIPCIDRs | List |
No | Recommended Cluster IP network segment |
| recommendedClusterIPCIDRIPv6s | List |
No | Recommended Cluster IP network segment IPv6 |
| requestID | String | Yes | Request ID. This ID is provided for issue localization. |
Request example
1POST /v2/net/recommend_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "vpcCIDR": "192.168.0.0/16",
6 "vpcCIDRIPv6": "",
7 "containerCIDR": "172.28.0.0/16",
8 "containerCIDRIPv6": "",
9 "clusterMaxServiceNum": 8,
10 "privateNetCIDRs": [
11 "172.16.0.0/12"
12 ],
13 "privateNetCIDRIPv6s": null,
14 "ipVersion": "ipv4"
15}
Response example
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 79f1993e-fc76-41c3-8f20-a22bd1010324
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6 "recommendedClusterIPCIDRs": [
7 "172.31.255.248/29",
8 "172.31.255.240/29",
9 "172.31.255.232/29",
10 "172.31.255.224/29",
11 "172.31.255.216/29"
12 ],
13 "recommendedClusterIPCIDRIPv6s": null,
14 "isSuccess": true,
15 "errMsg": "",
16 "requestID": "79f1993e-fc76-41c3-8f20-a22bd1010324"
17}
Recommended container network segment
Description
Recommended container network segment
Request structure
1POST /v2/net/recommend_container_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| clusterMaxNodeNum | Integer | Yes | RequestBody | Maximum number of nodes in the cluster |
| ipVersion | String | No | RequestBody | Container network IP address version, defaulting to IPv4, options:[IPv4, IPv6, dualStack] |
| k8sVersion | String | Yes | RequestBody | Cluster K8S version |
| maxPodsPerNode | Integer | Yes | RequestBody | Maximum number of pods per node |
| privateNetCIDRs | List |
No | RequestBody | IPv4 private network address range, options [10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16] |
| privateNetCIDRIPv6s | List |
No | RequestBody | IPv6 private network address range, currently only supporting [fc00::/7] |
| vpcID | String | Yes | RequestBody | VPC ID |
| vpcCIDR | String | No | RequestBody | VPC IPv4 network segment. Required when IP version is IPv4. |
| vpcCIDRIPv6 | String | No | RequestBody | VPC IPv6 network segment. Required when IP version is IPv6. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| errMsg | String | No | Error message |
| isSuccess | Boolean | Yes | Whether the request succeeded |
| recommendedContainerCIDRs | List |
No | Recommended container network segment |
| recommendedContainerCIDRIPv6s | List |
No | Recommended container network segment IPv6 |
| requestID | String | Yes | Request ID. This ID is provided for issue localization. |
Request example
1POST /v2/net/recommend_container_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "vpcID": "vpc-pi9fghaxcpnf",
6 "vpcCIDR": "192.168.0.0/16",
7 "vpcCIDRIPv6": "",
8 "clusterMaxNodeNum": 2,
9 "maxPodsPerNode": 32,
10 "privateNetCIDRs": [
11 "172.16.0.0/12"
12 ],
13 "privateNetCIDRIPv6s": null,
14 "k8sVersion": "1.16.8",
15 "ipVersion": "ipv4"
16}
Response example
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 162b630e-38f9-4b31-addc-f89339058e70
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6 "recommendedContainerCIDRs": [
7 "172.16.0.0/26",
8 "172.16.0.64/26",
9 "172.16.0.128/26",
10 "172.16.0.192/26",
11 "172.16.1.0/26"
12 ],
13 "recommendedContainerCIDRIPv6s": null,
14 "isSuccess": true,
15 "errMsg": "",
16 "requestID": "162b630e-38f9-4b31-addc-f89339058e70"
17}
Secondary network segment conflict detection
Description
Check whether the secondary network segment conflicts with the existing route in the current VPC
Request structure
1POST /v2/net/check_auxiliary_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| ipVersion | String | Yes | RequestBody | Container network IP address version, options: [IPv4, IPv6, dualStack] |
| ContainerCIDR | String | No | RequestBody | Container IPv4 network segment. Required when IP version is IPv4. |
| ContainerCIDRIPv6 | String | No | RequestBody | Container IPv6 network segment. Required when IP version is IPv6. |
| vpcID | String | Yes | RequestBody | VPC ID |
| vpcCIDR | String | No | RequestBody | VPC IPv4 network segment. Required when IP version is IPv4. |
| vpcCIDRIPv6 | String | No | RequestBody | VPC IPv6 network segment. Required when IP version is IPv6. |
| isEBPF | Bool | Yes | RequestBody | Whether eBPF acceleration is activated for the cluster |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| errMsg | String | No | Error message |
| isConflict | Bool | Yes | Conflict or not |
| requestID | String | Yes | Request ID. This ID is provided for issue localization. |
| isAuxiliary | Bool | Yes | Used when eBPF is activated to determine whether it is a secondary network segment |
Request example
1POST /v2/net/check_auxiliaryip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "vpcID": "vpc-pi9fghaxcpnf",
6 "vpcCIDR": "192.168.0.0/16",
7 "vpcCIDRIPv6": "",
8 "ContainerCIDR": "172.31.0.0/16",
9 "ContainerCIDRIPv6": "",
10 "ipVersion": "ipv4"
11}
Response example
1HTTP/1.1 200 OK
2X-Bce-Request-Id: d1b66c3d-b16f-4ff2-bedf-af21f6bcd827
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6 "isConflict": false,
7 "errMsg": "",
8 "requestID": "d1b66c3d-b16f-4ff2-bedf-af21f6bcd827",
9 "isAuxiliary": true
10}
