Creates a Global Accelerator (GA) instance.

Description

CreateAccelerator is an asynchronous operation. After you send a request, the system returns the ID of a GA instance, but the operation is still being performed in the system background. You can call the DescribeAccelerator operation to query the state of a GA instance.

  • If the GA instance is in the init state, it indicates that the GA instance is being created. In this case, you can perform only query operations.
  • If the GA instance is in the active state, it indicates that the GA instance is created.

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 CreateAccelerator

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

RegionId String Yes cn-hangzhou

The ID of the region in which to create the GA instance. Set the value to cn-hangzhou.

ClientToken String No 123e4567****

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 it is unique among all requests. The token can contain only ASCII characters.

Note If you do not set this parameter, the system sets ClientToken to the value of RequestId. The value of RequestId of each API request may be different.
Name String No test

The name of the GA instance.

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

Duration Integer Yes 1

The subscription duration of the GA instance.

  • If the PricingCycle parameter is set to Month, the valid values for the Duration parameter are 1 to 9.
  • If the PricingCycle parameter is set to Year, the valid values for the Duration parameter are 1 to 3.
PricingCycle String Yes Month

The billing cycle of the GA instance. Valid values:

  • Month: billed on a monthly basis.
  • Year: billed on an annual basis.
Spec String Yes 1

The type of GA instance. Valid values:

  • 1: Small Ⅰ
  • 2: Small Ⅱ
  • 3: Small Ⅲ
  • 5: Medium Ⅰ
  • 8: Medium Ⅱ
  • 10: Medium Ⅲ
  • 20: Large Ⅰ
  • 30: Large Ⅱ
  • 40: Large Ⅲ
  • 50: Large Ⅳ
  • 60: Large Ⅴ
  • 70: Large Ⅵ
  • 80: Large VⅡ
  • 90: Large VⅢ
  • 100: Super Large Ⅰ
  • 200: Super Large Ⅱ
Note GA instances Large III and above are not available by default. To use these instances , contact your Alibaba Cloud account manager.

Each instance type provides different capabilities. For more information, see Instance specifications.

AutoPay Boolean No false

Specifies whether to enable automatic payment. Default value: false. Valid values:

  • false: disables automatic payment. If you select this option, you must go to the Order Center to complete the payment after an order is generated.
  • true: enables automatic payment. Payments are automatically completed.
AutoUseCoupon String No false

Specifies whether to automatically use coupons when making payments. Default value: false. Valid values:

  • true: automatically pays bill by using coupons.
  • false: does not automatically pay bills by using coupons.
Note This parameter takes effect only when AutoPay is set to true.
AutoRenew Boolean No false

Specifies whether to enable auto-renewal for the GA instance. Default value: false. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.
AutoRenewDuration Integer No 1

The auto-renewal duration. Unit: months.

Valid values: 1 to 12. Default value: 1.

Note This parameter takes effect only when AutoRenew is set to true.
PromotionOptionNo String No 50003298014****

The coupon code.

Note
BandwidthBillingType String No BandwidthPackage

The bandwidth billing method.

  • BandwidthPackage: billed based on bandwidth plans.
  • CDT: billed based on data transfer.
  • CDT95: billed based on the 95th percentile bandwidth. The billing is managed by Cloud Data Transfer (CDT). This bandwidth billing method is not available by default. Contact your Alibaba Cloud account manager for more information.
IpSetConfig.AccessMode String No UserDefine

The access mode of the acceleration area. Valid values:

  • UserDefine: custom nearby access mode. You can select acceleration areas and regions based on your business requirements. GA allocates a separate EIP to each acceleration region.
  • Anycast: automatic nearby access mode. You do not need to specify an acceleration area. GA allocates an Anycast EIP to multiple regions across the globe. Users can connect to the nearest access point of the Alibaba Cloud global transmission network by sending requests to the Anycast EIP.
ResourceGroupId String No rg-aekzrnd67gq****

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

Response parameters

Parameter Type Example Description
RequestId String F591955F-5CB5-4CCE-A75D-17CF2085CE22

The request ID.

OrderId String 208257****

The ID of the order.

If you did not configure automatic payment, you must go to the Order Center to complete the payments.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateAccelerator
&RegionId=cn-hangzhou
&ClientToken=123e4567****
&Name=test
&Duration=1
&PricingCycle=Month
&Spec=1
&AutoPay=false
&AutoUseCoupon=false
&AutoRenew=false
&AutoRenewDuration=1
&PromotionOptionNo=50003298014****
&BandwidthBillingType=BandwidthPackage
&IpSetConfig={"AccessMode":"UserDefine"}
&ResourceGroupId=rg-aekzrnd67gq****
&Common request parameters

Sample success responses

XML format

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

<CreateAcceleratorResponse>
    <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>
    <OrderId>208257****</OrderId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
</CreateAcceleratorResponse>

JSON format

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

{
  "RequestId" : "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "OrderId" : "208257****",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****"
}

Error codes

HttpCode Error code Error message Description
500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. The error message returned because an error occurred when the request was being processed. Try again later.

For a list of error codes, see Service error codes.