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, network ID, or zone ID.

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. You can query up to 100 networks in each request.
cidrBlock	No	String	CIDR block of the subnet. Fuzzy query is supported.
zoneId	No	String	Zone ID to which the subnet belongs.
subnetStatus	No	String	Subnet status.
subnetName	No	String	Subnet name. Fuzzy query is supported.
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.

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/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:37Z",
                "cidrBlock": "10.0.0.0/24",
                "cidrBlockList": [
                    "10.0.0.0/24"
                ],
                "zoneId": "SIN-Z",
                "subnetStatus": "Available",
                "subnetDescription": "Subnet SIN-Default",
                "usageIpCount": 2,
                "subnetName": "Subnet SIN-Default",
                "isDefault": true
            }
        ],
        "totalCount": 1
    }
}

5. Developer Resources

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

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
500	DESCRIBE_SUBNET_FAILED	Query exception.
500	UNKNOW_SUBNET_STATUS	Abnormal subnet status.