接口功能介绍
查询用户指定的资源池专有网络vpc列表。
接口约束
天翼云用户。
URI
POST /osm/v2/console/listVpc
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | Integer | 当前分页 | 1 | |
| pageSize | 是 | Integer | 分页显示的数据条数 | 10 | |
| regionId | 是 | String | 资源池id | reg-700c065cbbd35b8 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 接口错误详情 | ||
| statusCode | String | 接口请求状态码 | 00000表示成功，其他为失败 | |
| message | String | 请口操作结果说明 | 操作成功或失败说明 | |
| page | Object | 返回数据对像 | page | |
| returnObj | Array of Objects | 返回数据对像数组 | returnObj |
表 page
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| current | Integer | 当前分页 | 3 | |
| size | Integer | 分页数据记录数 | 10 | |
| total | Integer | 总数据量 | 54 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpcID | String | 专有网络vpc id | vpc077343 | |
| name | String | 专有网络vpc名称 | vpc-sec78744 | |
| description | String | 专有网络vpc说明 | 说明vpc的用途等 | |
| CIDR | String | 子网 | 192.168.0.0/16 | |
| ipv6Enabled | Boolean | 是否启用ipv6 | false | |
| ipv6CIDRS | Array of Strings | ipv6 子网列表 | ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"] | |
| secondaryCIDRs | Array of Strings | 附加网段 | ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"] | |
| subnetIDs | Array of Strings | 子网 id 列表 | ["subnet-1a2b3c4d", "subnet-5e6f7g8h"] | |
| natGatewayIDs | Array of Strings | 网关 id 列表 | ["nat-gateway-1", "nat-gateway-2"] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"pageNumber": 1,
"pageSize": 10,
"regionId": "reg-700c065cbbd35b8",
"vpcId": "vpc-8293jdks732"
}
响应示例
{
"statusCode": "00000",
"message": "操作成功",
"page": {
"current": 3,
"size": 10,
"total": 54
},
"returnObj": [
{
"vpcID": "vpc077343",
"name": "vpc-sec78744",
"description": "说明vpc的用途等",
"CIDR": "192.168.0.0/16",
"ipv6Enabled": false,
"ipv6CIDRS": ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"],
"secondaryCIDRs": ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"],
"subnetIDs": ["subnet-1a2b3c4d", "subnet-5e6f7g8h"],
"natGatewayIDs": ["nat-gateway-1", "nat-gateway-2"]
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
