Last updated: 2019-11-29 17:20:31


1. API Description

Domain name for API request:

This API (DescribeSubnets) is used to query the list of subnets.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeSubnets
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SubnetIds.N No Array of String Queries the subnet instance ID, Such as subnet-pxir56ns. A maximum of 100 instances are allowed for each request. SubnetIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Filter condition. SubnetIds and Filters cannot be specified at the same time.
  • subnet-id - String - (Filter condition) Subnet instance name.
  • vpc-id - String - (Filter condition) VPC instance ID, such as vpc-f49l6u0z.
  • cidr-block - String - (Filter condition) VPC CIDR.
  • is-default - Boolean - (Filter condition) Whether it is the default subnet.
  • subnet-name - String - (Filter condition) Subnet name.
  • zone - String - (Filter condition) Availability zone.
  • Offset No String Offset
    Limit No String Number of values to be returned

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of instances matching the filter condition.
    SubnetSet Array of Subnet Subnet object.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Error Codes

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

    Error Code Description
    InvalidParameter.Coexist Parameters specified conflict with each other.
    InvalidParameterValue.Malformed Invalid input parameter format.
    ResourceNotFound Resource does not exist.

    5. Example

    Example 1 Query the subnet list

    Input example
    &Filters.0.Values.0=Default subnet in Guangzhou Zone 2
    &<Common request parameters>

    Output example

      "Response": {
        "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
        "SubnetSet": [
            "AvailableIpAddressCount": 4002,
            "CidrBlock": "",
            "CreatedTime": "2017-04-20 11:30:48",
            "EnableBroadcast": false,
            "IsDefault": true,
            "RouteTableId": "rtb-l2h8d7c2",
            "SubnetId": "subnet-otu92seu",
            "SubnetName": "Default subnet in Guangzhou Zone 2",
            "VpcId": "vpc-2at5y1pn",
            "Zone": "ap-guangzhou-dev-2"
        "TotalCount": 1

    6. Other Resources

    Cloud API 3.0 comes with the following development tools to make it easier to call the API.