Queries the Anycast elastic IP addresses (Anycast EIPs) in a specified access area.

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 ListAnycastEipAddresses

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

AnycastId String No aeip-2zeerraiwb7ujsxdc****

The ID of the Anycast EIP.

Note To ensure the accuracy of the query results, we do not recommend that you set AnycastIds and AnycastId at the same time.
AnycastIds.N String No aeip-2zeerraiwb7ujsxdc****

The IDs of Anycast EIPs.

You can enter at most 50 Anycast EIP IDs.

Note To ensure the accuracy of the query results, we do not recommend that you set AnycastIds and AnycastId at the same time.
AnycastEipAddress String No 139.95.XX.XX

The IP address that is allocated to the Anycast EIP.

ServiceLocation String No international

The access area of the Anycast EIP.

Set the value to international, which specifies the regions outside the Chinese mainland.

InstanceChargeType String No PostPaid

The billing method of the Anycast EIP.

Set the value to PostPaid, which specifies the pay-as-you-go billing method.

InternetChargeType String No PayByTraffic

The metering method of the Anycast EIP.

Set the value to PayByTraffic, which specifies the pay-by-data-transfer metering method.

Name String No doctest

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.

MaxResults Integer No. 50

The number of entries to return on each page. Valid values: 20 to 100. Default value: 50.

NextToken String No caeba0bbb2be03f84eb48b699f0a****

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.
Status String No 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
BusinessStatus String No Normal

The service status of the Anycast EIP. Valid values:

  • Normal: active
  • FinancialLocked: locked due to overdue payments
BindInstanceIds.N String No lb-2zebb08phyczzawe****

The IDs of the cloud resources to which the Anycast EIPs are associated.

You can enter at most 100 cloud resource IDs.

Response parameters

Parameter Type Example Description
TotalCount Integer 100

The number of entries returned.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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 of NextToken is returned, the value is the token that is used for the subsequent query.
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

AnycastList Array of Anycast

The list of Anycast EIPs.

Status String Associating

The status of the Anycast EIP.

  • Associating: being associated
  • Unassociating: being disassociated
  • Allocated: allocated
  • Associated: associated
  • Modifying: being modified
  • Releasing: being released
  • Released: released
CreateTime String 2022-04-22T01:37:38Z

The time when the Anycast EIP was created.

AnycastId String aeip-2zeerraiwb7ujsxdc****

The ID of the Anycast EIP.

AliUid Long 123440159596****

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

ServiceLocation String international

The access area of the Anycast EIP.

international: regions outside the Chinese mainland.

InstanceChargeType String PostPaid

The billing method of the Anycast EIP.

PostPaid: pay-as-you-go

IpAddress String 139.95.XX.XX

The IP address of the Anycast EIP.

Bandwidth Integer 200

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

Description String docdesc

The description of the Anycast EIP.

AnycastEipBindInfoList Array of AnycastEipBindInfo

The list of cloud resources with which the Anycast EIPs are associated.

BindInstanceType String SlbInstance

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

  • SlbInstance: an internal-facing Classic Load Balancer (CLB) instance deployed in a virtual private cloud (VPC). CLB is formerly known as Server Load Balancer (SLB).
  • NetworkInterface: an elastic network interface (ENI)
BindTime String 2022-04-23T01:37:38Z

The time when the Anycast EIP was associated.

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.

InternetChargeType String PayByTraffic

The metering method of the Anycast EIP.

PayByTraffic: pay-by-data-transfer

BusinessStatus String Normal

The service status of the Anycast EIP.

  • Normal: active
  • FinancialLocked: locked due to overdue payments
Name String docname

The name of the Anycast EIP.

ServiceManaged Integer 0

Indicates whether the resource is created by the service account.

  • 0: no
  • 1: yes

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListAnycastEipAddresses
&AnycastId=aeip-2zeerraiwb7ujsxdc****
&AnycastIds=["aeip-2zeerraiwb7ujsxdc****"]
&AnycastEipAddress=139.95.XX.XX
&ServiceLocation=international
&InstanceChargeType=PostPaid
&InternetChargeType=PayByTraffic
&Name=doctest
&MaxResults=50
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&Status=Associated
&BusinessStatus=Normal
&BindInstanceIds=["lb-2zebb08phyczzawe****"]
&Common request parameters

Sample success responses

XML format

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

<ListAnycastEipAddressesResponse>
    <TotalCount>100</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <AnycastList>
        <Status>Associating</Status>
        <CreateTime>2022-04-22T01:37:38Z</CreateTime>
        <AnycastId>aeip-2zeerraiwb7ujsxdc****</AnycastId>
        <ServiceLocation>international</ServiceLocation>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <IpAddress>139.95.XX.XX</IpAddress>
        <Bandwidth>200</Bandwidth>
        <Description>docdesc</Description>
        <AnycastEipBindInfoList>
            <BindInstanceType>SlbInstance</BindInstanceType>
            <BindTime>2022-04-23T01:37:38Z</BindTime>
            <BindInstanceRegionId>us-west-1</BindInstanceRegionId>
            <BindInstanceId>lb-2zebb08phyczzawe****</BindInstanceId>
        </AnycastEipBindInfoList>
        <InternetChargeType>PayByTraffic</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>docname</Name>
        <ServiceManaged>0</ServiceManaged>
    </AnycastList>
</ListAnycastEipAddressesResponse>

JSON format

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

{
  "TotalCount" : 100,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "AnycastList" : [ {
    "Status" : "Associating",
    "CreateTime" : "2022-04-22T01:37:38Z",
    "AnycastId" : "aeip-2zeerraiwb7ujsxdc****",
    "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
  } ]
}

Error codes

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