All Products
Search
Document Center

ENS:DescribeEnsEipAddresses

Last Updated:Mar 12, 2024

Queries elastic IP addresses (EIPs).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AllocationIdstringNo

The ID of the EIP that you want to query. You can specify up to 50 EIP IDs. Separate multiple IDs with commas (,).

eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddressstringNo

The EIP that you want to query. You can specify up to 50 EIPs. Separate multiple EIPs with commas (,).

192.168.0.1
AssociatedInstanceIdstringNo

The ID of the instance with which you want to associate the EIP.

lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceTypestringNo

The type of the instance with which you want to associate the EIP. Valid values:

  • EnsInstance: ENS instance in a VPC
  • SlbInstance: Edge Load Balancer (ELB) instance
SlbInstance
EnsRegionIdstringNo

The ID of the Edge Node Service (ENS) node.

cn-chengdu-telecom
EipNamestringNo

The name of the EIP.

test
StandbystringNo

Specifies whether the EIP is a secondary EIP. Valid values:

  • true
  • false
true
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100. Default value: 10.

50

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddressesobject []

Details about the EIP.

AllocationIdstring

The ID of the EIP.

eip-5sainglpw7qfem3icir4s****
AllocationTimestring

The time when the EIP was created.

1624885274000
Bandwidthinteger

The peak bandwidth of the EIP. Default value: 5. Valid values: 5 to 10000. Unit: Mbit/s.

50
ChargeTypestring

The billing method of the EIP. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go
PostPaid
Descriptionstring

The description of the EIP.

example
InstanceIdstring

The ID of the instance that is associated with the EIP.

lb-5sc3kum2e0sz34wbqrws9****
InstanceTypestring

The type of the instance that is associated with the EIP. Valid values:

  • EnsInstance: ENS instance in a VPC
  • SlbInstance: SLB instance
SlbInstance
InternetChargeTypestring

The metering method of the EIP.

  • 95BandwidthByMonth: Pay by monthly 95th percentile bandwidth
  • PayByBandwidth: Pay by bandwidth
95BandwidthByMonth
IpAddressstring

The EIP.

10.10.10
Namestring

The name of the EIP.

test
EnsRegionIdstring

The ID of the ENS node.

cn-xian-telecom
Statusstring

The status of the EIP. Valid values:

  • Associating
  • Unassociating
  • InUse
  • Available
Available
Ispstring

The Internet service provider (ISP). Valid values:

  • cmcc: China Mobile
  • unicom: China Unicom
  • telecom: China Telecom
cmcc
Standbyboolean

Indicates whether the EIP is a secondary EIP.

true
IpStatusstring

The running status of the EIP. This parameter is returned if the EIP is a secondary EIP. Valid values:

  • Stopped
  • Running
  • Starting
  • Stopping
Stopped
PageNumberinteger

The page number. Valid values: an integer that is greater than 0. Default value: 1.

1
PageSizeinteger

The number of entries per page. Default value: 10. Valid values: 10 to 100.

50
TotalCountinteger

The total number of entries returned.

7

Examples

Sample success responses

JSONformat

{
  "RequestId": "8629F679-B51D-4194-A1CC-5D8F504C362B",
  "EipAddresses": {
    "EipAddress": [
      {
        "AllocationId": "eip-5sainglpw7qfem3icir4s****",
        "AllocationTime": "1624885274000",
        "Bandwidth": 50,
        "ChargeType": "PostPaid",
        "Description": "example",
        "InstanceId": "lb-5sc3kum2e0sz34wbqrws9****",
        "InstanceType": "SlbInstance",
        "InternetChargeType": "95BandwidthByMonth",
        "IpAddress": "10.10.10",
        "Name": "test",
        "EnsRegionId": "cn-xian-telecom",
        "Status": "Available",
        "Isp": "cmcc",
        "Standby": true,
        "IpStatus": "Stopped"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 7
}

Error codes

HTTP status codeError codeError message
400ens.interface.errorAn error occurred while call the API.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-18The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Standby
Output ParametersThe response structure of the API has changed.
2023-03-02The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: EipName