DescribeEips

DescribeEips

1. API Description

This API is used to query the information of one or more specified elastic IPs. You can search for elastic IP information based on elastic IP ID, elastic IP name, etc.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipIds	No	Array of String	Elastic IP ID(s).
regionId	No	String	Region ID
name	No	String	Elastic IP name. Fuzzy search supported.
status	No	String	Status of the elastic IP.
isDefault	No	Boolean	Whether the elastic IP is the default public IP.
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.
dataSet	Array of EipInfo	List of elastic IPs.
totalCount	Integer	Number of elastic IPs meeting the filtering conditions.

4. Code Example

Example

Query the list of elastic IPs by page.

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

Request:
{
  "eipIds": ["xxx"],
  "regionId": "asia-east-1",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "eipId": "xxx",
        "name": "xxx",
        "regionId": "xxx",
        "isDefault": true,
        "status": "BINDED",
        "eipV4Type"："BGPLine",
        "internetChargeType": "ByTrafficPackage",
        "nicId": "xxx",
        "flowPackage": 1,
        "bandwidth": 2,
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx"
      }
    ]
  }
}

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

No error codes related to the API business logic. For other error codes, see Common Error Codes.