DescribeEnsEipAddresses - ENS - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeEnsEipAddresses	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AllocationId	string	No	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
EipAddress	string	No	The EIP that you want to query. You can specify up to 50 EIPs. Separate multiple EIPs with commas (,).	192.168.0.1
AssociatedInstanceId	string	No	The ID of the instance with which you want to associate the EIP.	lb-5t18quoohsrc3xkf86spmnu77
AssociatedInstanceType	string	No	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
EnsRegionId	string	No	The ID of the Edge Node Service (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 false	true
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	50

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	8629F679-B51D-4194-A1CC-5D8F504C362B
EipAddresses	array<object>	Details about the EIP.
	object
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: Mbit/s.	50
ChargeType	string	The billing method of the EIP. Valid values: 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 associated with the EIP.	lb-5sc3kum2e0sz34wbqrws9****
InstanceType	string	The type of the instance that is associated with the EIP. Valid values: EnsInstance: ENS instance in a VPC SlbInstance: SLB instance	SlbInstance
InternetChargeType	string	The metering method of the EIP. 95BandwidthByMonth: Pay by monthly 95th percentile bandwidth PayByBandwidth: Pay by bandwidth	95BandwidthByMonth
IpAddress	string	The EIP.	10.10.10
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. Valid values: Associating Unassociating InUse 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	The running status of the EIP. This parameter is returned if the EIP is a secondary EIP. Valid values: Stopped Running Starting Stopping	Stopped
PageNumber	integer	The page number. Valid values: an integer that is greater than 0. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 10. Valid values: 10 to 100.	50
TotalCount	integer	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 code	Error code	Error message
400	ens.interface.error	An error occurred while call the API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

Change history

Change time	Summary of changes	Operation
2023-07-18	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-03-02	The Error code has changed. The request parameters of the API has changed	View Change Details