DescribeCidrBlocks

1. API Description

This API is used to query the details of CIDR blocks.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cidrBlockIds	No	Array of String	IDs of the CIDR blocks. You can query up to 100 CIDR blocks in each request.
cidrBlock	No	String	IP range of CIDR block.
cidrBlockName	No	String	Name of CIDR block.
zoneId	No	String	Zone ID to which the CIDR blocks belong.
cidrBlockType	No	String	Type of CIDR block. The optional values are as follows: IPv4 IPv6
gateway	No	String	IP address of the gateway.
chargeType	No	String	CIDR block pricing model. PREPAID: subscription POSTPAID: pay-as-you-go
resourceGroupId	No	String	Resource group ID. If the value is null, then return all the CIDR blocks in the authorized resource groups.
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.
totalCount	Integer	Number of CIDR blocks meeting the filtering conditions.
dataSet	Array of CidrBlockInfo	Information on a CIDR block.

4. Code Example

Example

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeCidrBlocks
<Common Request Params>

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
  "requestId": "T9731D74B-4EA3-498E-AC75-4C036ABAF598",
  "response": {
    "requestId": "T9731D74B-4EA3-498E-AC75-4C036ABAF598",
    "totalCount": 14,
    "dataSet": [
      {
        "cidrBlockId": "767715590704998412",
        "cidrBlockType": "IPV4",
        "cidrBlockName": "mycidrblock",
        "zoneId": "CHI-A",
        "cidrBlock": "1.1.218.184/29",
        "gateway": "1.1.218.185",
        "availableIpStart": "1.1.218.186",
        "availableIpEnd": "1.1.218.190",
        "availableIpCount": 5,
        "instanceIds": [
          "780812773306141196"
        ],
        "status": "RECYCLE",
        "chargeType": "POSTPAID",
        "createTime": "2022-11-25T05:53:50Z",
        "expireTime": "2022-11-25T08:00:42Z",
        "resourceGroupId": "5eab5afc-88a2-46a9-bad3-278df7069f13",
        "resourceGroupName": "Default Resource Group"
      }
    ]
  }
}

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
404	INVALID_ZONE_NOT_FOUND	Zone not found.