1)接口功能介绍
查看vpc列表信息。
2)接口约束
该接口只返回有效的vpc列表。
3)URI
GET /v1/describeVpc。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | yn-lincang-1 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 应答结果 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
vpcDetailList | 是 | Object | vpc信息列表 | vpcDetailList |
表 vpcDetailList
参数 | 是否必填 | 参数类型 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
vpcId | 是 | String | 私有网络id | 1141 | |
vpcName | 是 | String | 私有网络名称 | eop-vpc_01 | |
createTime | 是 | String | 私有网络创建时间(Unix时间戳,秒) | 1669343515 | |
endIp | 是 | String | 私有网络结束ip | 10.0.0.255 | |
gateway | 是 | String | 网关Ip | 10.0.0.1 | |
startIp | 是 | String | 私有网络开始ip | 10.0.0.0 | |
state | 是 | String | 私有网络状态,VPC_ACTIVE:启用,VPC_DELETING:删除中,VPC_CREATING:创建中 | VPC_ACTIVE | |
subnetMask | 是 | Integer | 子网掩码 | 24 | |
cidrBlock | 否 | String | 私有网络的IPv4网段 | 10.0.0.0 |
6)请求示例
GET https://{host}/v1/describeVpc?nodeCode=yn-lincang-1
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vpcDetailList": [
{
"endIP": "10.255.255.255",
"vpcId": "1145",
"startIP": "10.0.0.0",
"createTime": "1669551305",
"state": "VPC_ACTIVE",
"vpcName": "vpc-do-not-bond-vm",
"subnetMask": 8,
"cidrBlock": "10.0.0.0/8",
"gateway": "10.0.0.1"
},
{
"endIP": "10.255.255.255",
"vpcId": "1142",
"startIP": "10.0.0.0",
"createTime": "1669356663",
"state": "VPC_ACTIVE",
"vpcName": "vpc-iqs0",
"subnetMask": 8,
"cidrBlock": "10.0.0.0/8",
"gateway": "10.0.0.1"
},
{
"endIP": "10.255.255.255",
"vpcId": "1094",
"startIP": "10.0.0.0",
"createTime": "1668584641",
"state": "VPC_ACTIVE",
"vpcName": "vpc-test",
"subnetMask": 8,
"cidrBlock": "10.0.0.0/8",
"gateway": "10.0.0.1"
}
]
},
"requestId": "d5bc4d2e-8352-4db1-a603-738c56f33640"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |