接口功能介绍
查询用户专有网络下子网列表
请求约束
URI
GET /v4/vpc/new-list-subnet
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池 ID | |
| vpcID | String | 是 | VPC 的 ID | vpc-tuid8d646e |
| subnetID | String | 否 | 多个 subnet 的 ID 之间用半角逗号（,）隔开。 | subnet-han72lo303,subnet-han72lo412 |
| pageNumber | Integer | 否 | 列表的页码，默认值为 1。 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 5 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| subnets | Object of Array | subnets 组 | |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 subnets
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| subnetID | String | subnet ID | subnet-han72lo303 |
| name | String | 名称 | subNet-yuioef8mp |
| description | String | 描述 | subNet |
| vpcID | String | VpcID | vpc-hfw53u96ku |
| availabilityZones | array | 子网所在的可用区名 | ["az1", "az2"] |
| routeTableID | String | 子网路由表 ID | rtb-fie3qauij5 |
| networkAclID | String | 子网 aclID | |
| CIDR | String | 子网网段，掩码范围为 16-28 位 | 192.168.0.0/24 |
| gatewayIP | String | 子网网关 | 192.168.0.1 |
| start | String | 子网网段起始 IP | 192.168.0.3 |
| end | String | 子网网段结束 IP | 192.168.0.253 |
| availableIPCount | Integer | 子网内可用 IPv4 数目 | 251 |
| ipv6Enabled | Integer | 是否配置了ipv6网段 | |
| enableIpv6 | Boolean | 是否开启 ipv6 | true |
| ipv6CIDR | String | 子网 Ipv6 网段，掩码范围为 16-28 位 | 2408:4002:10c4:4e03::/64 |
| ipv6Start | String | 子网内可用的起始 IPv6 地址 | 2408:4002:10c4:4e03:cb82 |
| ipv6End | String | 子网内可用的结束 IPv6 地址 | 2408:4002:10c4:4e03:cb11 |
| ipv6GatewayIP | String | v6 网关地址 | fe80::f816:3eff:fe2b:cb82 |
| dnsList | String of Array | DNS 服务器地址:默认为空；必须为正确的 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | ["114.114.114.114","8.8.8.8"] |
| ntpList | String of Array | NTP 服务器地址: 默认为空，必须为正确的域名或 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | |
| type | Integer | 子网类型 :当前仅支持：0（普通子网）, 1（裸金属子网） | 0 |
| updatedAt | String | 更新时间 | 2022-09-02T06:54:45Z |
请求示例
GET /v4/vpc/new-list-subnet?regionID=bb9fdb42056f11eda1610242ac110002&vpcID=vpc-w6sty9v8rr
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"subnets": [
{
"subnetID": "subnet-qc90zmk12u",
"name": "subnet-ldy-openapi-34",
"description": "ldy-openapi-test",
"vpcID": "vpc-w6sty9v8rr",
"CIDR": "172.16.14.0/24",
"availableIPCount": 251,
"gatewayIP": "172.16.14.1",
"availabilityZones": [],
"routeTableID": "rtb-udnix6dfg2",
"networkAclID": "",
"start": "172.16.14.3",
"end": "172.16.14.253",
"ipv6Enabled": 1,
"enableIpv6": true,
"ipv6CIDR": "100:1:1f2:7206::/64",
"ipv6Start": "100:1:1f2:7206::4",
"ipv6End": "100:1:1f2:7206:ffff:ffff:ffff:fffd",
"ipv6GatewayIP": "fe80::f816:3eff:fe43:dcba",
"dnsList": [
"8.8.4.4",
"114.114.114.114"
],
"ntpList": [],
"type": 0,
"createAt": "2022-10-08T04:09:40Z",
"updateAt": null
},
{
"subnetID": "subnet-7jibndv577",
"name": "subnet-ldy-openapi-341",
"description": "ldy-openapi-test",
"vpcID": "vpc-w6sty9v8rr",
"CIDR": "172.16.141.0/24",
"availableIPCount": 251,
"gatewayIP": "172.16.141.1",
"availabilityZones": [],
"routeTableID": "rtb-udnix6dfg2",
"networkAclID": "",
"start": "172.16.141.3",
"end": "172.16.141.253",
"ipv6Enabled": 1,
"ipv6CIDR": "100:1:1f2:7204::/64",
"ipv6Start": "100:1:1f2:7204::4",
"ipv6End": "100:1:1f2:7204:ffff:ffff:ffff:fffd",
"ipv6GatewayIP": "fe80::f816:3eff:feab:e436",
"dnsList": [
"8.8.4.4",
"114.114.114.114"
],
"ntpList": [],
"type": 0,
"createAt": "2022-10-08T07:12:31Z",
"updateAt": null
}
],
"currentCount": 10,
"totalCount": 20,
"totalPage": 2
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
