DescribeSubnets

DescribeSubnets

1. API Description

This API is used to query the details of subnets. You can filter the query results with the subnet ID or name.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
subnetIds	No	Array of String	Subnet ID(s).
name	No	String	Subnet name. Fuzzy query is supported.
cidrBlock	No	String	CIDR block of the subnet. Fuzzy query is supported.
regionId	No	String	Region ID of the subnet.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.
vpcIds	No	Array of String	ID list of global VPCs.
dhcpOptionsSetId	No	String	ID of the associated DHCP options set.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataSet	Array of SubnetInfo	Information on a subnet.
totalCount	Integer	Number of subnets meeting the filtering conditions.

4. Code Example

Example

Query all the available subnets with a CIDR block of 10.0.0.0/24.

POST /api/v2/zec 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": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "dataSet": [
      {
        "subnetId": "<subnetId>",
        "regionid": "asia-east-1",
        "name": "Test",
        "cidrBlock": "10.0.0.0/24",
        "gatewayIpAddress": "10.0.0.1",
        "ipv6GatewayIpAddress": "2001:2:0:xx::1",
        "ipv6CidrBlock": "2001:2:0:xx::/64",
        "stackType": "IPv4_IPv6",
        "ipv6Type": "Public",
        "vpcId": "<vpcId>",
        "vpcName": "Test",
        "usageIpv4Count": 253,
        "usageIpv6Count": 1,
        "createTime": "2022-01-01T01:00:00Z",
        "isDefault": true,
        "dhcpOptionsSetId": null
      }
    ],
    "totalCount": 1
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​