DescribeEnsEipAddresses - ENS - Alibaba Cloud Documentation Center

Call the DescribeEnsEipAddresses operation to query elastic IP addresses (EIPs).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeEnsEipAddresses

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AllocationId	string	No	The ID of the EIP to query. You can specify up to 50 EIP IDs. Separate multiple IDs with commas (,).	eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddress	string	No	The IP address of the EIP to query. You can specify up to 50 IP addresses. Separate multiple IP addresses with commas (,).	120.XXX.XXX.4
AssociatedInstanceId	string	No	The ID of the associated cloud service instance.	lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceType	string	No	The type of the cloud service instance to associate. Valid values: EnsInstance: an ENS instance in a virtual private cloud (VPC). SlbInstance: a Server Load Balancer (SLB) instance.	SlbInstance
EnsRegionId	string	No	The ID of the ENS node.	cn-chengdu-telecom
EipName	string	No	The name of the EIP.	test
Standby	string	No	Specifies whether the EIP is a secondary EIP. Valid values: true: The EIP is a secondary EIP. false: The EIP is not a secondary EIP.	true
IcmpReplyEnabled	boolean	No	Specifies whether to enable ICMP retrieval. Valid values: true (default): enabled. false: disabled.	false
EnsRegionIds	array	No	An array of ENS node IDs. The array can contain 1 to 100 IDs.
	string	No	The ID of the ENS node.	cn-chengdu-telecom-4
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	50

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddresses	object		[\"106.14.194.193\"]
EipAddress	array<object>	The details of the EIP.
	array<object>	The details of the EIP.
AllocationId	string	The ID of the EIP.	eip-5sainglpw7qfem3icir4s****
AllocationTime	string	The time when the EIP was created.	1624885274000
Bandwidth	integer	The peak bandwidth of the EIP. Default value: 5. Valid values: 5 to 10000. Unit: Mbps.	50
ChargeType	string	The billing method of the EIP. PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
Description	string	The description of the EIP.	example
InstanceId	string	The ID of the associated instance.	lb-5sc3kum2e0sz34wbqrws9****
InstanceType	string	The type of the associated cloud service instance. Valid values: EnsInstance: an ENS instance in a VPC. SlbInstance: an SLB instance.	SlbInstance
InternetChargeType	string	The billing method of the EIP. 95BandwidthByMonth: pay-by-95th-percentile bandwidth. PayByBandwidth: pay-by-bandwidth.	95BandwidthByMonth
IpAddress	string	The IP address of the EIP.	120.XXX.XXX.4
Name	string	The name of the EIP.	test
EnsRegionId	string	The ID of the ENS node.	cn-xian-telecom
Status	string	The status of the EIP. Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is associated. Available: The EIP is available.	Available
Isp	string	The Internet Service Provider (ISP). Valid values: cmcc: China Mobile. unicom: China Unicom. telecom: China Telecom.	cmcc
Standby	boolean	Indicates whether the EIP is a secondary EIP.	true
IpStatus	string	If the EIP is a secondary EIP, this parameter indicates the status of the EIP. Stopped: The EIP is stopped. Running: The EIP is running. Starting: The EIP is starting. Stopping: The EIP is stopping.	Stopped
Tags	object
Tag	array<object>	A collection of tags.
	object	A collection of tags.
Value	string	The tag value.	TestValue
Key	string	The tag key.	TestKey
TagValue `deprecated`	string	The tag value.	TestValue
TagKey `deprecated`	string	The tag key.	TestKey
IcmpReplyEnabled	boolean	Specifies whether ICMP retrieval is enabled. Valid values: true (default): enabled. false: disabled.	false
PageNumber	integer	The page number of the returned page. Valid values: >0. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Default value: 10. Valid values: 10 to 100.	50
TotalCount	integer	The total number of entries.	7

Examples

Success response

JSON format

{
  "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": "120.XXX.XXX.4",
        "Name": "test",
        "EnsRegionId": "cn-xian-telecom",
        "Status": "Available",
        "Isp": "cmcc",
        "Standby": true,
        "IpStatus": "Stopped",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "IcmpReplyEnabled": false
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 7
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.