接口功能介绍
查询子网列表
接口约束
无
URI
POST /v1/applicationAccessPointManage/listSubnet
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpcId | 是 | String | vpc id | vpc-w6sty9v8rr | |
| epId | 是 | String | 企业项目id | 1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 状态码 取值范围：200 成功 | 200 | |
| message | 是 | String | 提示信息 | Success | |
| returnObj | 是 | Object | 返回数据结构体 | {} | result |
| error | 否 | String | 错误码 仅错误时返回 格式为{服务编码}.{错误编号} | KMS.0269 |
表 result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| list | 是 | Array of Objects | 子网列表 | subnetList |
表 subnetList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnetID | 是 | String | 子网id | subnet-qc90zmk12u | |
| name | 是 | String | 名称 | subnet-ldy-openapi-34 | |
| description | 是 | String | 描述 | ldy-openapi-test | |
| vpcID | 是 | String | vpc id | vpc-w6sty9v8rr | |
| availabilityZones | 是 | Array of Strings | 子网所在的可用区名 | ["az1", "az2"] | |
| routeTableID | 是 | String | 路由表id | rtb-udnix6dfg2 | |
| networkAclID | 是 | String | 子网acl id | ||
| CIDR | 是 | String | 子网网段 | 172.16.14.0/24 | |
| gatewayIP | 是 | String | 网关ip | 172.16.14.1 | |
| start | 是 | String | 子网网段起始IP | 172.16.14.3 | |
| end | 是 | String | 子网网段结束IP | 172.16.14.253 | |
| availableIPCount | 是 | Integer | 子网内可用ipv4数目 | 251 | |
| ipv6CIDR | 是 | String | ipv6子网列表 | 100:1:1f2:7206::/64 | |
| ipv6Start | 是 | String | 子网内可用的起始IPv6地址 | 100:1:1f2:7206::4 | |
| ipv6End | 是 | String | 子网内可用的结束IPv6地址 | 100:1:1f2:7206:ffff:ffff:ffff:fffd | |
| ipv6GatewayIP | 是 | String | ipv6网关ip | fe80::f816:3eff:fe43:dcba | |
| dnsList | 是 | Array of Strings | DNS服务器地址 | ["8.8.4.4","114.114.114.114"] | |
| ntpList | 是 | Array of Strings | NTP服务器地址 | ||
| type | 是 | Integer | 子网类型 | 0 | |
| createdAt | 是 | String | 创建时间 | 2022-10-08T04:09:40Z | |
| updatedAt | 是 | String | 更新时间 | 2022-10-08T05:09:40Z |
枚举参数
参数名 type
| 枚举值 | 类型 | 说明 |
|---|---|---|
| 0 | Integer | 普通子网 |
| 1 | Integer | 裸金属子网 |
请求示例
请求url
https://{host}/v1/applicationAccessPointManage/listSubnet请求头header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}请求体body
{
"vpcId": "vpc-hu189akjd",
"epId": "1"
}响应示例
{
"statusCode": 200,
"message": "获取子网列表成功",
"returnObj": {
"list": [
{
"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",
"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",
"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
}
]
}
}
