接口功能介绍
查询用户专有网络。
接口约束
无。
URI
GET /v4/vpc/query
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 资源池 ID | |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| vpcID | String | 是 | VPC 的 ID | vpc-hfw53u96ku |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 |
| message | String | statusCode 为 900 时的错误信息, 英文 | |
| description | String | statusCode 为 900 时的错误信息，中文 | |
| returnObj | object | 接口业务数据 | |
| errorCode | String | 业务细分错误码，三段式：product.module.code |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| vpcID | String | vpc ID | vpc-hfw53u96ku |
| name | String | 名称 | ewx9vckaqa |
| description | String | 描述 | description |
| CIDR | String | 子网 | 192.168.0.0/16 |
| ipv6Enabled | bool | 是否开启 ipv6 | true |
| ipv6CIDRs | array | ipv6 子网列表 | ["2408:4002:10c4:4e03::/64", "2408:4002:10c4:4e04::/64"] |
| subnetIDs | String of Array | 子网 id 列表 | |
| natGatewayIDs | String of Array | 网关 id 列表 | |
| secondaryCIDRS | String of Array | 附加网段 |
请求示例
GET /v4/vpc/query?regionID=bb9fdb42056f11eda1610242ac110002&vpcID=vpc-nfzn54dny2
响应示例
{
"statusCode":800,
"errCode":"SUCCESS",
"message":"success",
"descritption": "",
"returnObj":{
"vpcID": "vpc-nfzn54dny2",
"name": "vpc-liyu001",
"natGatewayIDs": ["natgw-1b6pn4u3u8"],
"secondaryCIDRs": "",
"subnetIDs": ["subnet-bbdo1h73kg", "subnet-kaikr201yn"],
"ipv6CIDRS": ["fc00:100:4000:bd00::/56"],
"CIDR": "192.168.0.0/16",
"ipv6Enabled": true,
"description": ""
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
