All Products
Search
Document Center

Global Accelerator:CreateAccelerator

Last Updated:May 16, 2024

Creates a Global Accelerator (GA) instance.

Operation description

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.

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
ga:CreateAcceleratorWrite
  • Accelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ClientTokenstringNo

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.
123e4567****
NamestringNo

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.

test
DurationintegerNo

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.
1
PricingCyclestringNo

The billing cycle of the GA instance. Valid values:

  • Month: billed on a monthly basis.
  • Year: billed on an annual basis.
Month
SpecstringNo

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.

1
AutoPaybooleanNo

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.
false
AutoUseCouponstringNo

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.
false
AutoRenewbooleanNo

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

  • true: enables auto-renewal.
  • false: disables auto-renewal.
false
AutoRenewDurationintegerNo

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.
1
PromotionOptionNostringNo

The coupon code.

Note
50003298014****
BandwidthBillingTypestringNo

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.
BandwidthPackage
IpSetConfigobjectNo

The configurations of the acceleration area.

AccessModestringNo

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.
UserDefine
ResourceGroupIdstringNo

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

rg-aekzrnd67gq****
Tagobject []No

The tags of the GA instance.

KeystringNo

The tag key of the GA instance. The tag key cannot be an empty string.

The tag key can be up to 64 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag keys.

tag-key
ValuestringNo

The tag value of the GA instance. The tag value cannot be an empty string.

The tag value can be up to 128 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag values.

tag-value
InstanceChargeTypestringNo

The billing method of the GA. Default value is PREPAY (subscription).

  • PREPAY : subscription.
  • POSTPAY : pay-as-you-go
PREPAY
DryRunbooleanNo

Specifies whether only to precheck the request. Default value: false. Valid values:

  • true: prechecks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F591955F-5CB5-4CCE-A75D-17CF2085CE22
OrderIdstring

The ID of the order.

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

208257****
AcceleratorIdstring

The ID of the GA instance.

ga-bp17frjjh0udz4qz****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: InstanceChargeType
    Added Input Parameters: DryRun
2023-04-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
2023-03-31The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag