Queries Anycast elastic IP addresses (Anycast EIPs), such as the status, bandwidth, and associated resources.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| Eipanycast:ListAnycastEipAddresses | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AnycastId | string | No | The ID of the Anycast EIP. Note
To ensure the accuracy of the query result, we do not recommend that you specify AnycastIds and AnycastId at the same time.
| aeip-2zeerraiwb7ujsxdc**** |
| AnycastIds | array | No | The IDs of Anycast EIPs. You can enter at most 50 Anycast EIP IDs. Note
To ensure the accuracy of the query result, we do not recommend that you specify AnycastIds and AnycastId at the same time.
| |
| string | No | aeip-2zeerraiwb7ujsxdc**** | ||
| AnycastEipAddress | string | No | The IP address that is allocated to the Anycast EIP. | 139.95.XX.XX |
| ServiceLocation | string | No | The access area of the Anycast EIP. Set the value to international, which specifies the 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 of the Anycast EIP. Set the value to PayByTraffic, which specifies the pay-by-data-transfer metering method. | PayByTraffic |
| Name | string | No | The name of the Anycast EIP. The name must be 0 to 128 characters in length, and can contain digits, hyphens (-), and underscores (_). The name must start with a letter. | doctest |
| Tags | object [] | No | The tags. | |
| Key | string | No | The tag key of the resource. You can specify up to 20 tag keys. You cannot specify empty strings as tag keys. The key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with 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. It can be an empty string. The value cannot exceed 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter but cannot start with 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. Valid values: 20 to 100. Default value: 50. | 50 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| caeba0bbb2be03f84eb48b699f0a**** |
| Status | string | No | The status of the Anycast EIP. Valid values:
| Associated |
| BusinessStatus | string | No | The service status of the Anycast EIP. Valid values:
| Normal |
| BindInstanceIds | array | No | The IDs of the cloud resources with which the Anycast EIPs are associated. You can enter at most 100 cloud resource IDs. | |
| string | No | lb-2zebb08phyczzawe**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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,
"Tags": [
{
"Key": "",
"Value": ""
}
]
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-24 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-04-07 | API Description Update. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||
|