ListAnycastEipAddresses - Anycast Elastic IP Address - Alibaba Cloud Documentation Center

Queries the details of Anycast EIPs in a specified access area, including their status, peak bandwidth, and information about bound cloud resources.

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 support 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

eipanycast:ListAnycastEipAddresses

list

*AnycastEipAddress

acs:eipanycast:{#regionId}:{#accountId}:anycast/*

None

Request parameters

Parameter	Type	Required	Description	Example
AnycastId	string	No	The ID of the Anycast EIP instance. Note To ensure query accuracy, we recommend that you do not specify AnycastIds and AnycastId at the same time.	aeip-2zeerraiwb7ujsxdc****
AnycastIds	array	No	The list of Anycast EIP instance IDs. You can enter up to 50 Anycast EIP instance IDs. Note To ensure query accuracy, we recommend that you do not specify AnycastIds and AnycastId at the same time.
	string	No	The list of Anycast EIP instance IDs. You can enter up to 50 Anycast EIP instance IDs. Note To ensure query accuracy, we recommend that you do not specify AnycastIds and AnycastId at the same time.	aeip-2zeerraiwb7ujsxdc****
AnycastEipAddress	string	No	The IP address of the Anycast EIP instance.	139.95.XX.XX
ServiceLocation	string	No	The access area of the Anycast EIP instance. Set the value to international, which specifies regions outside the Chinese mainland.	international
InstanceChargeType	string	No	The billing method of the Anycast EIP. Set the value to PostPaid, which specifies the pay-as-you-go billing method.	PostPaid
InternetChargeType	string	No	The metering method for Internet data transfer of the Anycast EIP instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer metering method.	PayByTraffic
Name	string	No	The name of the Anycast EIP instance. The name must be 0 to 128 characters in length, start with a letter or a Chinese character, and can contain digits, hyphens (-), and underscores (_).	doctest
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-aekzthsmwsnfuni
Tags	array<object>	No	The tag information.
	object	No	The tag information.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`. Note You must specify at least one of Tag.N (Tag.N.Key and Tag.N.Value).	1
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Note You must specify at least one of Tag.N (Tag.N.Key and Tag.N.Value).	tag1
MaxResults	integer	No	The number of entries to return on each page when a list is displayed. Valid values: 20 to 100. Default value: 50.	50
NextToken	string	No	The token that is used for the next query. Valid values: You do not need to specify this parameter for the first query or if no next query is to be sent. If a next query is to be sent, set the value to the NextToken value returned from the previous API call.	caeba0bbb2be03f84eb48b699f0a****
Status	string	No	The IP address status. Valid values: Associating: The Anycast EIP is being associated. Unassociating: The Anycast EIP is being disassociated. Allocated: The Anycast EIP is allocated. Associated: The Anycast EIP is associated. Modifying: The Anycast EIP is being modified. Releasing: The Anycast EIP is being released. Released: The Anycast EIP is released.	Associated
BusinessStatus	string	No	The service status of the Anycast EIP instance. Valid values: Normal: The Anycast EIP is in a normal state. FinancialLocked: The Anycast EIP is locked due to an overdue payment.	Normal
BindInstanceIds	array	No	The list of IDs of cloud resources with which the Anycast EIP is associated. You can enter up to 100 cloud resource IDs.	lb-2zebb08phyczzawe****
	string	No	The list of IDs of cloud resources with which the Anycast EIP is associated. You can enter up to 100 cloud resource IDs.	lb-2zebb08phyczzawe****

Response parameters

Parameter	Type	Description	Example
	object	The list of returned information.
TotalCount	integer	The number of entries in the list.	100
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, it indicates that no next query is to be sent. If a value is returned for NextToken, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
AnycastList	array<object>	The list of Anycast EIP instances.
	object	The list of Anycast EIP instances.
Status	string	The IP address status. Associating: The Anycast EIP is being associated. Unassociating: The Anycast EIP is being disassociated. Allocated: The Anycast EIP is allocated. Associated: The Anycast EIP is associated. Modifying: The Anycast EIP is being modified. Releasing: The Anycast EIP is being released. Released: The Anycast EIP is released.	Associating
CreateTime	string	The time when the Anycast EIP instance was created.	2022-04-22T01:37:38Z
AnycastId	string	The ID of the Anycast EIP instance.	aeip-2zeerraiwb7ujsxdc****
AliUid	integer	The ID of the Alibaba Cloud account to which the Anycast EIP instance belongs.	123440159596****
ServiceLocation	string	The access area of the Anycast EIP instance. international: regions outside the Chinese mainland.	international
InstanceChargeType	string	The billing method of the Anycast EIP instance. PostPaid: the pay-as-you-go billing method.	PostPaid
IpAddress	string	The IP address of the Anycast EIP instance.	139.95.XX.XX
Bandwidth	integer	The peak bandwidth of the Anycast EIP instance. Unit: Mbps.	200
Description	string	The description of the Anycast EIP instance.	docdesc
AnycastEipBindInfoList	array<object>	The list of binding information about the Anycast EIP instance.
	object	The list of binding information about the Anycast EIP instance.
BindInstanceType	string	The type of the cloud resource with which the Anycast EIP instance is associated. SlbInstance: a private Classic Load Balancer (CLB) instance in a virtual private cloud (VPC). NetworkInterface: an elastic network interface (ENI).	SlbInstance
BindTime	string	The time when the Anycast EIP instance was bound to the cloud resource.	2022-04-23T01:37:38Z
BindInstanceRegionId	string	The ID of the region where the associated cloud resource is deployed.	us-west-1
BindInstanceId	string	The ID of the cloud resource with which the Anycast EIP instance is associated.	lb-2zebb08phyczzawe****
InternetChargeType	string	The metering method of the Anycast EIP instance. PayByTraffic: the pay-by-data-transfer metering method.	PayByTraffic
BusinessStatus	string	The service status of the Anycast EIP instance. Normal: The Anycast EIP is in a normal state. FinancialLocked: The Anycast EIP is locked due to an overdue payment.	Normal
Name	string	The name of the Anycast EIP instance.	docname
ServiceManaged	integer	Indicates whether the resource is created by a service account. 0: The resource is not created by a service account. 1: The resource is created by a service account.	0
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aekzthsmwsnfuni
Tags	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Examples

Success response

JSON format

{
  "TotalCount": 100,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "AnycastList": [
    {
      "Status": "Associating",
      "CreateTime": "2022-04-22T01:37:38Z",
      "AnycastId": "aeip-2zeerraiwb7ujsxdc****",
      "AliUid": 0,
      "ServiceLocation": "international",
      "InstanceChargeType": "PostPaid",
      "IpAddress": "139.95.XX.XX",
      "Bandwidth": 200,
      "Description": "docdesc",
      "AnycastEipBindInfoList": [
        {
          "BindInstanceType": "SlbInstance",
          "BindTime": "2022-04-23T01:37:38Z",
          "BindInstanceRegionId": "us-west-1",
          "BindInstanceId": "lb-2zebb08phyczzawe****"
        }
      ],
      "InternetChargeType": "PayByTraffic",
      "BusinessStatus": "Normal",
      "Name": "docname",
      "ServiceManaged": 0,
      "ResourceGroupId": "rg-aekzthsmwsnfuni\n",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.