DescribeAvailableIpv4Resources

1. API Description

This API is used to query available IPv4 CIDR blocks.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
chargeType	Yes	String	CIDR block pricing model. PREPAID: subscription POSTPAID: pay-as-you-go
zoneId	No	String	Zone ID to which the CIDR blocks belong.

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.
availableIpv4Resources	Array of AvailableIpv4Resource	List of available IPv4 CIDR blocks.

4. Code Example

Example

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

Request:
{
  "chargeType": "PREPAID"
}

Response:
{
  "requestId": "T9681F843-24B6-4926-86BA-F3D5C25563E3",
  "response": {
    "requestId": "T9681F843-24B6-4926-86BA-F3D5C25563E3",
    "availableIpv4Resources": [
      {
        "zoneId": "HKG-A",
        "netmask": 29,
        "sellStatus": "SELL"
      },
      {
        "zoneId": "SEL-A",
        "netmask": 29,
        "sellStatus": "SOLD_OUT"
      },
      {
        "zoneId": "HKG-A",
        "netmask": 26,
        "sellStatus": "SELL_SHORTAGE"
      }
    ]
  }
}

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.