All Products
Search
Document Center

Anycast Elastic IP Address:AllocateAnycastEipAddress

Last Updated:Mar 03, 2024

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.

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:AllocateAnycastEipAddressWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BandwidthstringNo

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

Valid values: 200 to 1000.

Default value: 1000.

Note The maximum bandwidth is not a guaranteed service and is for reference only.
200
ServiceLocationstringYes

The access area of the Anycast EIP.

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

international
InstanceChargeTypestringNo

The billing method of the Anycast EIP.

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

PostPaid
InternetChargeTypestringNo

The metering method of the Anycast EIP.

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

PayByTraffic
ClientTokenstringNo

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

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

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-001****
NamestringNo

The name of the Anycast EIP.

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

doctest
DescriptionstringNo

The description of the Anycast EIP.

The description must be 0 to 256 characters in length and cannot start with http:// or https://.

docdesc
ResourceGroupIdstringNo

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

rg-acfm3obzjukv53a

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

FBDB18D8-E91E-4978-8D6C-6E2E3EE10133
AnycastIdstring

The ID of the Anycast EIP.

aeip-bp1ix34fralt4ykf3****
OrderIdstring

The order ID.

1422000****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-08-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-24The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.
2023-04-07API Description Updatesee changesets
Change itemChange content
API DescriptionAPI Description Update.