接口功能介绍
查询VPC子网列表
接口约束
无
URI
GET /v3/vpc/subnet/describe
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
vpcOid | 是 | String | VPC ID | vpc-3z109ivhsly4j73nm4k6l | |
pageNum | 否 | Integer | 页码,至少1,默认1 | 1 | |
pageSize | 否 | Integer | 每页数量,最大100,默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK | |
returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Long | 总记录数 | 1 | |
list | Array of Objects | 数据列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
subnetOid | String | VPC子网ID | sn-vpma7obaz5i6wgv4fh38f | |
subnetName | String | 子网名称 | fooName | |
cidr | String | IPV4网段 | 192.168.0.0/24 | |
gatewayIp | String | 子网网关IP | 192.168.0.1 | |
dnsList | Array of Objects | 子网DNS服务器列表 | ['114.114.114.114'] | dnsList |
status | String | 状态(Active-已激活;Processing-处理中;Unhealthy-异常;Deleting-删除中) | Active |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"subnetOid":"fooId","subnetName":"fooName","cidr":"192.168.0.0/24","gatewayIp":"192.168.0.1","dnsList":["114.114.114.114"],"status":"Active"}]}}
状态码
请参考 状态码
错误码
请参考 错误码