DescribeEipAddresses - Elastic Compute Service - Alibaba Cloud Documentation Center

DescribeEipAddresses.

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeEipAddresses for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:DescribeEipAddresses

get

*Address

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes
Status	string	No
EipAddress	string	No
AllocationId	string	No
ISP	string	No
PageNumber	integer	No
PageSize	integer	No
Filter.1.Key	string	No
Filter.2.Key	string	No
Filter.1.Value	string	No
Filter.2.Value	string	No
LockReason	string	No
AssociatedInstanceType	string	No
AssociatedInstanceId	string	No
ChargeType	string	No

Response elements

Element	Type	Description	Example
	object
PageSize	integer
RequestId	string
PageNumber	integer
TotalCount	integer
EipAddresses	object
EipAddress	array<object>
	array<object>
Status	string
AllocationTime	string
ChargeType	string
InstanceId	string
InstanceType	string
RegionId	string
IpAddress	string
Bandwidth	string
ExpiredTime	string
AllocationId	string
InternetChargeType	string
EipBandwidth	string
OperationLocks	object
LockReason	array<object>
	object
LockReason	string

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "EipAddresses": {
    "EipAddress": [
      {
        "Status": "",
        "AllocationTime": "",
        "ChargeType": "",
        "InstanceId": "",
        "InstanceType": "",
        "RegionId": "",
        "IpAddress": "",
        "Bandwidth": "",
        "ExpiredTime": "",
        "AllocationId": "",
        "InternetChargeType": "",
        "EipBandwidth": "",
        "OperationLocks": {
          "LockReason": [
            {
              "LockReason": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	The specified AssociatedInstanceType parameter is invalid.
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.	The specified billing method is not supported. Specify a supported billing method.
400	InvalidAliuid	User Id is not valid.
400	ResourceQueryError	The specified resource is queried error.
400	InstanceType.Invalid	InstanceType is not null
400	InvalidParameter	Parameter exceed max length
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.
400	OperationFailed.Endpoint	Operation failed because the RegionId is unavailable in this endpoint.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred. Try again later.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound
404	InvalidFilterValue
404	InvalidLockReason.NotFound	The specified LockReason is not found	The specified LockReason parameter does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.