Creates a Global Accelerator (GA) instance.

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 where the GA instance is deployed. 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 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 uses RequestId as ClientToken. RequestId may be different for each API request.
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.

  • 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 specification of the GA instance. Valid values:

  • 1: Small Ⅰ
  • 2: Small Ⅱ
  • 3: Small Ⅲ
  • 5: Medium Ⅰ
  • 8: Medium Ⅱ
  • 10: Medium Ⅲ

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

AutoPay Boolean No false

Specifies whether to enable automatic payment. Valid values:

  • false (default): 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 pay bills by using coupons. Valid values:

  • true: yes
  • false (default): no
Note This parameter is required only if AutoPay is set to true.
AutoRenew Boolean No false

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

  • true: yes
  • false (default): no
AutoRenewDuration Integer No 1

The auto-renewal period. Unit: months.

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

Note This parameter is required only if AutoRenew is set to true.
IpSetConfig Object No

The configurations of the acceleration area.

AccessMode String No UserDefine

The access mode of the acceleration area. Valid values:

  • UserDefine: custom nearby access mode. You can select an acceleration area and region 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.

Response parameters

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

The ID of the request.

OrderId String 208257****

The ID of the order.

If bills are not automatically paid, 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
&IpSetConfig={"AccessMode":"UserDefine"}
&Common request parameters

Sample 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

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