Creates an Anycast elastic IP address (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 AllocateAnycastEipAddress

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

Bandwidth String No 200

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

Valid values: 200 to 1000.

Default value: 1000.

Note The maximum bandwidth value is not a guaranteed value. It indicates the upper limit of bandwidth and is only for reference.
ServiceLocation String Yes international

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

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.

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
Name String No doctest

The name of the Anycast EIP.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

Description String No docdesc

The description of the Anycast EIP.

Response parameters

Parameter Type Example Description
RequestId String FBDB18D8-E91E-4978-8D6C-6E2E3EE10133

The ID of the request.

AnycastId String aeip-bp1ix34fralt4ykf3****

The ID of the Anycast EIP.

OrderId String 1422000****

The ID of the order.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AllocateAnycastEipAddress
&Bandwidth=200
&ServiceLocation=international
&InstanceChargeType=PostPaid
&InternetChargeType=PayByTraffic
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&Name=doctest
&Description=docdesc
&Common request parameters

Sample success responses

XML format

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

<AllocateAnycastEipAddressResponse>
    <RequestId>FBDB18D8-E91E-4978-8D6C-6E2E3EE10133</RequestId>
    <AnycastId>aeip-bp1ix34fralt4ykf3****</AnycastId>
    <OrderId>1422000****</OrderId>
</AllocateAnycastEipAddressResponse>

JSON format

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

{
  "RequestId" : "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133",
  "AnycastId" : "aeip-bp1ix34fralt4ykf3****",
  "OrderId" : "1422000****"
}

Error codes

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