DescribeVpcSubnets
DescribeVpcSubnets
1. 接口描述
本接口用于查询一台或多台指定子网的信息。用户可以根据Subnet ID、 VPC ID、Subnet 名称等信息来搜索Subnet信息。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
subnetIds
否
Array of String
子网 ID。
取值可以由多个Subnet ID组成一个。最多支持100个ID查询。
cidrBlock
否
String
子网的CIDR。 支持模糊查询。
vpcId
否
String
子网所属的可用区ID。
subnetName
否
String
子网的名称。 支持模糊查询。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
pageNum
否
Integer
返回的分页数。
默认为1。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
符合条件的数据总数。
4. 代码示例
1. 分页查询CidrBlock为“10.0.0.0/24”的Subnet列表
POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeSubnets
<Common Request Params>
Request:
{
"cidrBlock": "10.0.0.0/24",
"pageSize": 10,
"pageNum": 1
}
Response:
{
"requestId": "T1EB061B4-E20D-4CE5-8EF7-63073E1AB3E1",
"response": {
"requestId": "T1EB061B4-E20D-4CE5-8EF7-63073E1AB3E1",
"dataSet": [
{
"subnetId": "914782535395847474",
"instanceIdList": [
"instance001",
"instance002"
],
"totalIpCount": 253,
"createTime": "2023-06-16T03:49:36Z",
"cidrBlock": "10.0.0.0/24",
"zoneId": "SIN-Z",
"subnetStatus": "Available",
"usageIpCount": 2,
"subnetName": "Subnet SIN-Default",
"isDefault": false
}
],
"totalCount": 1
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
500
DESCRIBE_SUBNET_FAILED
查询异常
500
UNKNOW_SUBNET_STATUS
Subnet状态异常
最后更新于