Queries information about a specified Anycast elastic IP address (Anycast EIP).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAnycastEipAddress

The operation that you want to perform. Set the value to DescribeAnycastEipAddress.

Ip String No 139.95.XX.XX

The IP address of the Anycast EIP.

AnycastId String No aeip-bp1ix34fralt4ykf3****

The ID of the Anycast EIP.

BindInstanceId String No lb-2zebb08phyczzawe****

The ID of the cloud resource with which the Anycast EIP is associated.

Response parameters

Parameter Type Example Description
Status String Associated

The status of the Anycast EIP. Valid values:

  • Associating: being associated
  • Unassociating: being disassociated
  • Allocated: allocated
  • Associated: associated
  • Modifying: being modified
  • Releasing: being released
  • Released: released
Description String doctest

The description of the Anycast EIP.

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

InstanceChargeType String PostPaid

The billing method of the Anycast EIP.

Set the value to PostPaid. This value indicates the pay-as-you-go billing method.

CreateTime String 2021-04-23T01:37:38Z

The time when 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.

AnycastEipBindInfoList Array of AnycastEipBindInfo

The information about the cloud resource with which the Anycast EIP is associated.

BindInstanceType String SlbInstance

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

  • SlbInstance: an internal-facing Server Load Balancer (SLB) instance that is deployed in a virtual private cloud (VPC)
  • NetworkInterface: an elastic network interface (ENI)
BindTime String 2021-04-23T02:37:38Z

The time when the Anycast EIP was associated.

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

Status String BINDING

The status of the cloud resource. Valid values:

  • BINDING: being associated
  • BINDED: associated
  • UNBINDING: being disassociated
  • DELETED: deleted
  • MODIFYING: being modified
BindInstanceRegionId String us-west-1

The ID of the region where the cloud resource is deployed.

BindInstanceId String lb-2zebb08phyczzawe****

The ID of the cloud resource with which the Anycast EIP is associated.

PopLocations Array of PopLocation

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 a cloud resource, the system returns information about access points in all access areas.

PopLocation String us-west-1-pop

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 a cloud resource, the system returns information about access points in all access areas.

AssociationMode String Default

The association mode. Valid values:

  • Default: the default mode. In this mode, associated cloud resources are set as default origin servers.
  • Normal: the standard mode. In this mode, associated cloud resources are set as standard origin servers.
PrivateIpAddress String 192.168.XX.XX

The secondary private IP address of the associated ENI.

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

BusinessStatus String Normal

The service status of the Anycast EIP. Valid values:

  • Normal: active
  • FinancialLocked: locked due to overdue payments
InternetChargeType String PayByTraffic

The metering method of the Anycast EIP.

The value is set to PayByTraffic, which indicates the pay-by-data-transfer metering method.

Name String docname

The name of the Anycast EIP.

AnycastId String aeip-bp1ix34fralt4ykf3****

The ID of the Anycast EIP.

ServiceLocation String international

The area from which you can use the Anycast EIP to access the backend server over the Internet.

The value is set to international, which indicates the areas outside the Chinese mainland.

Bandwidth Integer 5

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

IpAddress String 139.95.XX.XX

The IP address of the Anycast EIP.

Bid String 26842

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

AliUid Long 25346073170691****

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAnycastEipAddress
&Ip=139.95.XX.XX
&AnycastId=aeip-bp1ix34fralt4ykf3****
&BindInstanceId=lb-2zebb08phyczzawe****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAnycastEipAddressResponse>
    <Status>Associated</Status>
    <Description>doctest</Description>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <InstanceChargeType>PostPaid</InstanceChargeType>
    <CreateTime>2021-04-23T01:37:38Z</CreateTime>
    <AnycastEipBindInfoList>
        <BindInstanceType>SlbInstance</BindInstanceType>
        <BindTime>2021-04-23T02:37:38Z</BindTime>
        <Status>BINDING</Status>
        <BindInstanceRegionId>us-west-1</BindInstanceRegionId>
        <BindInstanceId>lb-2zebb08phyczzawe****</BindInstanceId>
        <PopLocations>
            <PopLocation>us-west-1-pop</PopLocation>
        </PopLocations>
        <AssociationMode>Default</AssociationMode>
        <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
    </AnycastEipBindInfoList>
    <BusinessStatus>Normal</BusinessStatus>
    <InternetChargeType>PayByTraffic</InternetChargeType>
    <Name>docname</Name>
    <AnycastId>aeip-bp1ix34fralt4ykf3****</AnycastId>
    <ServiceLocation>international</ServiceLocation>
    <Bandwidth>5</Bandwidth>
    <IpAddress>139.95.XX.XX</IpAddress>
    <Bid>26842</Bid>
</DescribeAnycastEipAddressResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : 5,
  "IpAddress" : "139.95.XX.XX",
  "Bid" : "26842"
}

Error codes

For a list of error codes, visit the API Error Center.