接口功能介绍
查询用户专有网络列表
接口约束
URI
GET /v4/vpc/list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池 ID | bb9fdb42056f11eda1610242ac110002 |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| vpcID | String | 否 | 多个 VPC 的 ID 之间用半角逗号（,）隔开。 | vpc-hfw53u96ku,vpc-hfw53u54du |
| 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 | 接口业务数据 | 见下表 |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| vpcs | Array of Objects | vpc 组 | 见下表 |
vpcs
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| vpcID | String | vpc 示例 ID | vpc-hfw53u96ku |
| name | String | 名称 | ewx9vckaqa |
| description | String | 描述 | description |
| CIDR | String | 子网 | 192.168.0.0/16 |
| ipv6Enabled | Boolean | 是否开启 ipv6 | true |
| enableIpv6 | Boolean | 是否开启 ipv6 | true |
| ipv6CIDRS | Array of String | ipv6 子网列表 | ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"] |
| subnetIDs | Array of String | 子网 id 列表 | |
| natGatewayIDs | Array of String | 网关 id 列表 | |
| secondaryCIDRS | Array of String | 附加网段 |
请求示例
GET /v4/vpc/list?regionID=bb9fdb42056f11eda1610242ac110002
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"vpcs": [
{
"vpcID": "vpc-w6sty9v8rr",
"name": "vpc-314b-ldy-2",
"description": "",
"CIDR": "172.16.0.0/16",
"ipv6Enabled": true,
"enableIpv6": true,
"ipv6CIDRS": [
"100:1:1f2:7200::/56"
],
"secondaryCIDRs": [],
"subnetIDs": [
"subnet-7jibndv577",
"subnet-qc90zmk12u"
],
"natGatewayIDs": []
}
]
},
"currentCount": 10,
"totalCount": 10,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
