DescribeInstanceAvailableEipResources

1. API Description

This API is used to query list of elastic IPs that can be bound to an instance.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceId	Yes	String	Instance ID. To obtain the instance ID, you can call DescribeInstances and look for instanceId in the response.

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.
instanceEipResources	Array of InstanceAvailableEip	List of available elastic IPs that can be bound to an instance.

4. Code Example

Example

Query list of elastic IPs that can be bound to an instance

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

Request：
{
    "instanceId": "instanceId1"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": { 
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"，
    "instanceEipResources": [
        {
             "eipId": "eipId1",
             "ipAddress: "xx.x.x.x"
        }
    ]
  }
}

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
403	INVALID_ESXI_NOT_SUPPORT	Instances of ESXi operating system are not supported.