DescribeEipAvailableResources

1. API Description

This API is used to query elastic IP resources for sale in the zone.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipChargeType	Yes	String	Elastic IP pricing model. PREPAID: subscription POSTPAID: pay-as-you-go
zoneId	Yes	String	Zone ID to which the elastic IPs belong. If this parameter is not passed in, the elastic IPs in all zones return.

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.
eipResources	Array of EipAvailable	Zone list of available elastic IPs.

4. Code Example

Example

Query prepaid elastic IP resources for sale in the zone: SEL-A

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

Request：
{
    "eipChargeType": "PREPAID",
    "zoneId": "SEL-A"
}

Response：
{
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "response": {
        "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
        "eipResources": [
            {
                 "zoneId"："SEL-A"，
                 "status"："SELL"
            }
        ]
    }
}

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 does not exist.