All Products
Search
Document Center

ENS:DescribeEipAddresses

Last Updated:Mar 12, 2024

Queries the properties of 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
EnsRegionIdstringYes

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

cn-nanjing-cmcc
EipsstringNo

The information about the EIPs.

[\"eip-5rd9i3pftfgbavl4y1b7hm4a3\"]

Response parameters

ParameterTypeDescriptionExample
object
EipAddressesobject []

Details of the EIPs.

Eipstring

The information about an EIP.

203.107.XX.XX
InstanceIdInternetIpstring

The public IP address of the ENS instance.

203.107.XX.XX
RequestIdstring

The ID of the request.

CCFD3F24-44AF-5508-B18D-5100BFC68602

Examples

Sample success responses

JSONformat

{
  "EipAddresses": {
    "EipAddress": [
      {
        "Eip": "203.107.XX.XX",
        "InstanceIdInternetIp": "203.107.XX.XX"
      }
    ]
  },
  "RequestId": "CCFD3F24-44AF-5508-B18D-5100BFC68602"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InsufficientEipCapacityInsufficient EIP inventory under the specified territory.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version