Network相关接口
更新时间：2025-08-21
检查集群ClusterIP网段
描述
检查集群 ClusterIP 网段
请求结构
Plain Text
1POST /v2/net/check_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| ipVersion | String | 是 | RequestBody 参数 | 容器网络IP地址版本，可选[ipv4, ipv6, dualStack] |
| clusterIPCIDR | String | 否 | RequestBody 参数 | Cluster IPv4 网段. IP版本为IPv4时必填 |
| clusterIPCIDRIPv6 | String | 否 | RequestBody 参数 | Cluster IPv6 网段. IP版本为IPv6时必填 |
| vpcID | String | 是 | RequestBody 参数 | VPC ID |
| vpcCIDR | String | 否 | RequestBody 参数 | VPC IPv4 网段. IP版本为IPv4时必填 |
| vpcCIDRIPv6 | String | 否 | RequestBody 参数 | VPC IPv6 网段. IP版本为IPv6时必填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| errMsg | String | 否 | 错误信息 |
| isConflict | String | 是 | 是否冲突 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
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{
6 "vpcID": "vpc-pi9fghaxcpnf",
7 "vpcCIDR": "192.168.0.0/16",
8 "vpcCIDRIPv6": "",
9 "clusterIPCIDR": "172.31.0.0/16",
10 "clusterIPCIDRIPv6": "",
11 "ipVersion": "ipv4"
12}返回示例
Plain Text
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{
7 "isConflict": false,
8 "errMsg": "",
9 "requestID": "40165eb4-0fc7-405e-bcdf-10ba2ffc1ee3"
10}检查集群容器网络网段
描述
检查集群容器网络网段
请求结构
Plain Text
1POST /v2/net/check_container_network_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| ipVersion | String | 否 | RequestBody 参数 | 容器网络IP地址版本，默认值为 ipv4，可选 [ ipv4, ipv6, dualStack ] |
| clusterIPCIDR | String | 否 | RequestBody 参数 | Cluster IPv4 网段. IP 版本为 IPv4 时必填 |
| clusterIPCIDRIPv6 | String | 否 | RequestBody 参数 | Cluster IPv6 网段. IP 版本为 IPv6 时必填 |
| containerCIDR | String | 否 | RequestBody 参数 | 容器网络 IPv4 网段. IP 版本为 IPv4 时必填 |
| containerCIDRIPv6 | String | 否 | RequestBody 参数 | 容器网络 IPv6 网段. IP 版本为 IPv6 时必填 |
| maxPodsPerNode | Integer | 是 | RequestBody 参数 | 单节点最大容器组数量 |
| vpcID | String | 是 | RequestBody 参数 | VPC ID |
| vpcCIDR | String | 否 | RequestBody 参数 | VPC IPv4 网段. IP版本为IPv4时必填 |
| vpcCIDRIPv6 | String | 否 | RequestBody 参数 | VPC IPv6 网段. IP版本为IPv6时必填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| clusterIPCIDRConflict | ClusterIPCIDRConflict | 否 | ClusterIP 网段冲突信息 |
| containerCIDRConflict | ContainerCIDRConflict | 否 | 容器网段冲突信息 |
| errMsg | String | 否 | 错误信息 |
| isConflict | String | 是 | 是否冲突 |
| maxNodeNum | String | 是 | 最大节点数量 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
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{
6 "vpcID": "vpc-pi9fghaxcpnf",
7 "vpcCIDR": "192.168.0.0/16",
8 "vpcCIDRIPv6": "",
9 "containerCIDR": "172.28.0.0/16",
10 "containerCIDRIPv6": "",
11 "clusterIPCIDR": "172.31.0.0/16",
12 "clusterIPCIDRIPv6": "",
13 "maxPodsPerNode": 256,
14 "ipVersion": "ipv4"
15}返回示例
Plain Text
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{
7 "maxNodeNum": 256,
8 "isConflict": false,
9 "errMsg": "",
10 "containerCIDRConflict": null,
11 "clusterIPCIDRConflict": null,
12 "requestID": "a2c5b12b-6005-4266-a8e8-f5b3d903a5c7"
13}推荐ClusterIP网络网段
描述
推荐 ClusterIP 网络网段
请求结构
Plain Text
1POST /v2/net/recommend_clusterip_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterMaxServiceNum | Integer | 是 | RequestBody 参数 | 集群最大 Service 数量 |
| ipVersion | String | 否 | RequestBody 参数 | 容器网络IP地址版本，默认值为 ipv4，可选 [ ipv4, ipv6, dualStack ] |
| containerCIDR | String | 否 | RequestBody 参数 | 容器网络 IPv4 网段. IP 版本为 IPv4 时必填 |
| containerCIDRIPv6 | String | 否 | RequestBody 参数 | 容器网络 IPv6 网段. IP 版本为 IPv6 时必填 |
| privateNetCIDRs | List<String> | 否 | RequestBody 参数 | IPv4私有网络地址段，可选 [ 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 ] |
| privateNetCIDRIPv6s | List<String> | 否 | RequestBody 参数 | IPv6私有网络地址段，目前仅支持 [ fc00::/7 ] |
| vpcCIDR | String | 否 | RequestBody 参数 | VPC IPv4 网段. IP版本为IPv4时必填 |
| vpcCIDRIPv6 | String | 否 | RequestBody 参数 | VPC IPv6 网段. IP版本为IPv6时必填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| errMsg | String | 否 | 错误信息 |
| isSuccess | Boolean | 是 | 请求是否成功 |
| recommendedClusterIPCIDRs | List<String> | 否 | 推荐 Cluster IP 网段 |
| recommendedClusterIPCIDRIPv6s | List<String> | 否 | 推荐 Cluster IP 网段 IPv6 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
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{
6 "vpcCIDR": "192.168.0.0/16",
7 "vpcCIDRIPv6": "",
8 "containerCIDR": "172.28.0.0/16",
9 "containerCIDRIPv6": "",
10 "clusterMaxServiceNum": 8,
11 "privateNetCIDRs": [
12 "172.16.0.0/12"
13 ],
14 "privateNetCIDRIPv6s": null,
15 "ipVersion": "ipv4"
16}返回示例
Plain Text
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{
7 "recommendedClusterIPCIDRs": [
8 "172.31.255.248/29",
9 "172.31.255.240/29",
10 "172.31.255.232/29",
11 "172.31.255.224/29",
12 "172.31.255.216/29"
13 ],
14 "recommendedClusterIPCIDRIPv6s": null,
15 "isSuccess": true,
16 "errMsg": "",
17 "requestID": "79f1993e-fc76-41c3-8f20-a22bd1010324"
18}推荐容器网络网段
描述
推荐容器网络网段
请求结构
Plain Text
1POST /v2/net/recommend_container_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterMaxNodeNum | Integer | 是 | RequestBody 参数 | 集群最大节点数 |
| ipVersion | String | 否 | RequestBody 参数 | 容器网络IP地址版本，默认值为 ipv4，可选 [ ipv4, ipv6, dualStack ] |
| k8sVersion | String | 是 | RequestBody 参数 | 集群的K8S版本 |
| maxPodsPerNode | Integer | 是 | RequestBody 参数 | 单节点最大容器组数量 |
| privateNetCIDRs | List<String> | 否 | RequestBody 参数 | IPv4私有网络地址段，可选 [ 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 ] |
| privateNetCIDRIPv6s | List<String> | 否 | RequestBody 参数 | IPv6私有网络地址段，目前仅支持 [ fc00::/7 ] |
| vpcID | String | 是 | RequestBody 参数 | VPC ID |
| vpcCIDR | String | 否 | RequestBody 参数 | VPC IPv4 网段. IP版本为IPv4时必填 |
| vpcCIDRIPv6 | String | 否 | RequestBody 参数 | VPC IPv6 网段. IP版本为IPv6时必填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| errMsg | String | 否 | 错误信息 |
| isSuccess | Boolean | 是 | 请求是否成功 |
| recommendedContainerCIDRs | List<String> | 否 | 推荐容器网段 |
| recommendedContainerCIDRIPv6s | List<String> | 否 | 推荐容器网段 IPv6 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
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{
6 "vpcID": "vpc-pi9fghaxcpnf",
7 "vpcCIDR": "192.168.0.0/16",
8 "vpcCIDRIPv6": "",
9 "clusterMaxNodeNum": 2,
10 "maxPodsPerNode": 32,
11 "privateNetCIDRs": [
12 "172.16.0.0/12"
13 ],
14 "privateNetCIDRIPv6s": null,
15 "k8sVersion": "1.16.8",
16 "ipVersion": "ipv4"
17}返回示例
Plain Text
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{
7 "recommendedContainerCIDRs": [
8 "172.16.0.0/26",
9 "172.16.0.64/26",
10 "172.16.0.128/26",
11 "172.16.0.192/26",
12 "172.16.1.0/26"
13 ],
14 "recommendedContainerCIDRIPv6s": null,
15 "isSuccess": true,
16 "errMsg": "",
17 "requestID": "162b630e-38f9-4b31-addc-f89339058e70"
18}辅助网段冲突检测
描述
检查辅助网段是否与当前vpc内已有路由冲突
请求结构
Plain Text
1POST /v2/net/check_auxiliary_cidr HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| ipVersion | String | 是 | RequestBody 参数 | 容器网络IP地址版本，可选[ipv4, ipv6, dualStack] |
| ContainerCIDR | String | 否 | RequestBody 参数 | Container IPv4 网段. IP版本为IPv4时必填 |
| ContainerCIDRIPv6 | String | 否 | RequestBody 参数 | Container IPv6 网段. IP版本为IPv6时必填 |
| vpcID | String | 是 | RequestBody 参数 | VPC ID |
| vpcCIDR | String | 否 | RequestBody 参数 | VPC IPv4 网段. IP版本为IPv4时必填 |
| vpcCIDRIPv6 | String | 否 | RequestBody 参数 | VPC IPv6 网段. IP版本为IPv6时必填 |
| isEBPF | Bool | 是 | RequestBody 参数 | 集群是否启用了ebpf加速 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| errMsg | String | 否 | 错误信息 |
| isConflict | Bool | 是 | 是否冲突 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
| isAuxiliary | Bool | 是 | 在启用ebpf时使用，用于判断是否为辅助网段 |
请求示例
Plain Text
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{
6 "vpcID": "vpc-pi9fghaxcpnf",
7 "vpcCIDR": "192.168.0.0/16",
8 "vpcCIDRIPv6": "",
9 "ContainerCIDR": "172.31.0.0/16",
10 "ContainerCIDRIPv6": "",
11 "ipVersion": "ipv4"
12}返回示例
Plain Text
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{
7 "isConflict": false,
8 "errMsg": "",
9 "requestID": "d1b66c3d-b16f-4ff2-bedf-af21f6bcd827",
10 "isAuxiliary": true
11}