All Products
Search
Document Center

Anycast Elastic IP Address:DescribeAnycastEipAddress

Last Updated:Mar 03, 2024

Queries an Anycast elastic IP address (Anycast EIP), such as the status, bandwidth, and associated resources.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
Eipanycast:DescribeAnycastEipAddressREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpstringNo

The IP address of the Anycast EIP.

Note You must specify Ip or AnycastId.
139.95.XX.XX
AnycastIdstringNo

The ID of the Anycast EIP.

Note You must specify Ip or AnycastId.
aeip-bp1ix34fralt4ykf3****
BindInstanceIdstringNo

The ID of the endpoint with which the Anycast EIP is associated.

lb-2zebb08phyczzawe****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Statusstring

The status of the Anycast EIP.

  • Associating
  • Unassociating
  • Allocated
  • Associated
  • Modifying
  • Releasing
  • Released
Associated
Descriptionstring

The description of the Anycast EIP.

doctest
RequestIdstring

The request ID.

4EC47282-1B74-4534-BD0E-403F3EE64CAF
InstanceChargeTypestring

The billing method of the Anycast EIP.

Only PostPaid may be returned, which indicates the pay-as-you-go billing method.

PostPaid
CreateTimestring

The point in time at which the Anycast EIP was created.

The time follows the ISO8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-04-23T01:37:38Z
AnycastEipBindInfoListobject []

The information about the endpoint with which the Anycast EIP is associated.

BindInstanceTypestring

The type of endpoint with which the Anycast EIP is associated. Valid values:

  • SlbInstance: a CLB instance in a VPC.
  • NetworkInterface: an elastic network interface (ENI).
SlbInstance
BindTimestring

The time when the Anycast EIP was associated.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2021-04-23T02:37:38Z
Statusstring

The status of the endpoint. Valid values:

  • BINDING
  • BINDED
  • UNBINDING
  • DELETED
  • MODIFYING
BINDING
BindInstanceRegionIdstring

The ID of the region in which the endpoint is deployed.

us-west-1
BindInstanceIdstring

The ID of the endpoint with which the Anycast EIP is associated.

lb-2zebb08phyczzawe****
PopLocationsobject []

The information about the access points in associated access areas when you associate an Anycast EIP with a cloud resource.

If this is your first time associating an Anycast EIP with an endpoint, the system returns information about access points in all access areas.

PopLocationstring

The information about the access points in associated access areas when you associate an Anycast EIP with a cloud resource.

If this is your first time associating an Anycast EIP with an endpoint, the system returns information about access points in all access areas.

us-west-1-pop
AssociationModestring

The association mode. Valid values:

  • Default: the default mode. In this mode, the associated endpoint serves as the default origin server.
  • Normal: the standard mode. In this mode, the associated endpoint serves as a standard origin server.
Default
PrivateIpAddressstring

The secondary private IP address of the associated ENI.

This parameter is valid only when BindInstanceType is set to NetworkInterface.

192.168.XX.XX
BusinessStatusstring

The service status of the Anycast EIP. Valid values:

  • Normal
  • FinancialLocked
Normal
InternetChargeTypestring

The metering method of the Anycast EIP.

Only PayByTraffic may be returned, which indicates the pay-by-data-transfer metering method.

PayByTraffic
Namestring

The name of the Anycast EIP.

docname
AnycastIdstring

The ID of the Anycast EIP.

aeip-bp1ix34fralt4ykf3****
ServiceLocationstring

The access area of the Anycast EIP.

Only international may be returned, which indicates the areas outside the Chinese mainland.

international
Bandwidthinteger

The maximum bandwidth of the Anycast EIP. Unit: Mbit/s.

200
IpAddressstring

The IP address of the Anycast EIP.

139.95.XX.XX
Bidstring

The BID of the account to which the Anycast EIP belongs.

26842
AliUidlong

The ID of the account to which the Anycast EIP belongs.

25346073170691****
ResourceGroupIdstring

The ID of the resource group to which the instance belongs.

rg-acfmzssisocarfy
Tagsobject []

The information about the tags.

Keystring

The tag key.

1
Valuestring

The tag value.

1

Examples

Sample success responses

JSONformat

{
  "Status": "Associated",
  "Description": "doctest",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "InstanceChargeType": "PostPaid",
  "CreateTime": "2021-04-23T01:37:38Z",
  "AnycastEipBindInfoList": [
    {
      "BindInstanceType": "SlbInstance",
      "BindTime": "2021-04-23T02:37:38Z",
      "Status": "BINDING",
      "BindInstanceRegionId": "us-west-1",
      "BindInstanceId": "lb-2zebb08phyczzawe****",
      "PopLocations": [
        {
          "PopLocation": "us-west-1-pop"
        }
      ],
      "AssociationMode": "Default",
      "PrivateIpAddress": "192.168.XX.XX"
    }
  ],
  "BusinessStatus": "Normal",
  "InternetChargeType": "PayByTraffic",
  "Name": "docname",
  "AnycastId": "aeip-bp1ix34fralt4ykf3****",
  "ServiceLocation": "international",
  "Bandwidth": 200,
  "IpAddress": "139.95.XX.XX",
  "Bid": "26842",
  "AliUid": 0,
  "ResourceGroupId": "rg-acfmzssisocarfy",
  "Tags": [
    {
      "Key": "1",
      "Value": "1"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-07-24The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-04-07API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.