Use DescribeEnsEipAddresses to query elastic IP addresses - ENS - Alibaba Cloud - ENS

Queries elastic IP addresses (EIPs) in Edge Node Service (ENS).

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 instance to query. You can specify up to 50 EIP instance IDs separated by commas (,).	eip-5q9uwkd9bznjpxz8hr6cirnjk
EipAddress	string	No	The IP address of the EIP to query. You can specify up to 50 EIP addresses separated by commas (,).	120.XXX.XXX.4
AssociatedInstanceId	string	No	The instance ID of the cloud service.	lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceType	string	No	The type of the cloud service instance to associate. Valid values: EnsInstance: a VPC-type ENS instance. SlbInstance: a load balancing instance.	SlbInstance
Status	string	No	The status of the EIP. Valid values: Associating: being associated. Unassociating: being disassociated. InUse: allocated. Available: available.	InUse
EnsRegionId	string	No	The ENS edge zone ID.	cn-chengdu-telecom
EipName	string	No	The name of the EIP.	test
Standby	string	No	Specifies whether the EIP is a standby EIP. Valid values: true: standby. false: not standby.	true
IcmpReplyEnabled	boolean	No	Specifies whether ICMP echo reply is enabled. Valid values: true (default): enabled. false: disabled.	false
EnsRegionIds	array	No	The array of ENS edge zone IDs. Array length: 1 to 100.
	string	No	The ENS edge zone ID.	cn-chengdu-telecom-4
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: 10.	50
LockReason	string	No	The lock type. financial: locked due to overdue payment.	financial

Response elements

Element	Type	Description	Example
	object	Schema of Response
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 instance 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: Mbit/s.	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 instance that is currently associated with the EIP.	lb-5sc3kum2e0sz34wbqrws9****
InstanceType	string	The type of the cloud service instance to associate. Valid values: EnsInstance: a VPC-type ENS instance. SlbInstance: a load balancing instance.	SlbInstance
InternetChargeType	string	The billing method of the EIP. 95BandwidthByMonth: monthly 95th percentile bandwidth billing. PayByBandwidth: pay-by-bandwidth billing.	95BandwidthByMonth
IpAddress	string	The IP address of the EIP.	120.XXX.XXX.4
Name	string	The name of the EIP instance.	test
EnsRegionId	string	The ENS edge zone ID.	cn-xian-telecom
Status	string	The status of the EIP. Associating: being associated. Unassociating: being disassociated. InUse: allocated. Available: 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 standby EIP.	true
IpStatus	string	The running status of the EIP when it is a standby EIP. Stopped: stopped. Running: running. Starting: starting. Stopping: stopping.	Stopped
Tags	object
Tag	array<object>	The tags.
	object	The 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 echo reply is enabled. Valid values: true (default): enabled. false: disabled.	false
BandwidthPackageBandwidth	integer	The bandwidth value of the Internet Shared Bandwidth instance that the EIP is added to. Unit: Mbit/s.	100
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance that the EIP is added to.	cbwp-5***
OperationLocks	object
Lock	array<object>	The lock details.
	object	The lock details.
LockReason	string	The lock type. financial: locked due to overdue payment.	financial
PageNumber	integer	The page number of the query list. Valid values: > 0. Default value: 1.	1
PageSize	integer	The number of entries per page for paging queries. 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,
        "BandwidthPackageBandwidth": 100,
        "BandwidthPackageId": "cbwp-5***",
        "OperationLocks": {
          "Lock": [
            {
              "LockReason": "financial"
            }
          ]
        }
      }
    ]
  },
  "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.