DescribeVpcs
DescribeVpcs
1. 接口描述
本接口用于查询一个或多个指定VPC的信息。用户可以根据VPC ID、Subnet ID、 VPC节点ID、VPC名称等信息来搜索VPC信息。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
vpcIds
否
Array of String
VPC ID。
取值可以由多个VPC ID组成一个。最多支持100个ID查询。
cidrBlock
否
String
VPC的CIDR。
vpcName
否
String
VPC的名称。
vpcRegionId
否
String
VPC的节点ID。
resourceGroupId
否
String
资源组的ID。
如果不传,则返回该用户可见的所有资源组内的VPC。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
pageNum
否
Integer
返回的分页数。
默认为1。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
符合条件的数据总数。
4. 代码示例
1. 分页查询Vpc列表
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeVpcs
<Common Request Params>
Request:
{
"pageSize": 10,
"pageNum": 1
}
Response:
{
"requestId": "T890357C5-9793-4668-BB32-217134475DAC",
"response": {
"requestId": "T890357C5-9793-4668-BB32-217134475DAC",
"totalCount": 9,
"dataSet": [
{
"vpcId": "your-vpc-id",
"vpcRegionId": "HKG5",
"vpcRegionName": "HKG-A_C",
"vpcName": "Test-VPC",
"cidrBlock": "10.0.0.0/8",
"createTime": "2022-08-01T00:00:00Z",
"vpcStatus": "AVAILABLE",
"resourceGroupId": "your-resource-group-id",
"resourceGroupName": "Default Resource Group"
}
...
]
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
最后更新于