CreateAccelerator - Global Accelerator - Alibaba Cloud Documentation Center

Alibaba Cloud Global Accelerator (GA) is a network acceleration service that provides services to users across the globe. It uses the high-quality Border Gateway Protocol (BGP) bandwidth and global transmission network of Alibaba Cloud to provide low-latency access to the global network. GA reduces the impact of network issues, such as latency, jitter, and packet loss, on service quality and provides a high-availability and high-performance network acceleration service. You can call the CreateAccelerator operation to create a Global Accelerator instance.

Operation description

The CreateAccelerator operation is asynchronous. After you send a request, the system returns a Global Accelerator instance ID. The instance is then created in the background. You can call the DescribeAccelerator operation to query the status of a Global Accelerator instance:

If the Global Accelerator instance is in the init state, the instance is being created. In this state, you can only perform query operations.
If the Global Accelerator instance is in the active state, the instance is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:CreateAccelerator

create

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can create a token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. 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.	123e4567****
Name	string	No	The name of the Global Accelerator instance. The name must be 1 to 128 characters in length, start with a letter, and can contain letters, digits, underscores (_), and hyphens (-).	test
Duration	integer	No	The subscription duration. If PricingCycle is set to Month, the valid values for Duration are 1 to 9. If PricingCycle is set to Year, the valid values for Duration are 1 to 3. Note This parameter is required if InstanceChargeType (the billing method of the GA instance) is set to PREPAY (subscription).	1
PricingCycle	string	No	The billing cycle. Valid values: Month: The subscription is billed by month. Year: The subscription is billed by year. Note This parameter is required if InstanceChargeType (the billing method of the GA instance) is set to PREPAY (subscription).	Month
Spec	string	No	The specification of the Global Accelerator instance. Valid values: 1: Small Ⅰ. 2: Small Ⅱ. 3: Small Ⅲ. 5: Medium Ⅰ. 8: Medium Ⅱ. 10: Medium Ⅲ. 20: Large Ⅰ. 30: Large Ⅱ. 40: Large Ⅲ. 50: Large IV. 60: Large V. 70: Large VI. 80: Large VII. 90: Large VIII. 100: Ultra-large Ⅰ. 200: Ultra-large Ⅱ. Note The Large III and higher specifications are available only to users who are added to the whitelist. To use these specifications, contact your account manager. This parameter is required if InstanceChargeType (the billing method of the GA instance) is set to PREPAY (subscription). The capabilities of GA instances vary based on their specifications. For more information, see Instance types.	1
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false (default): disables automatic payment. You must go to the Order Hub to complete the payment. true: enables automatic payment. Payments are automatically completed.	false
AutoUseCoupon	string	No	Specifies whether to automatically apply coupons to your bills. Valid values: true: yes. false (default): no. Note This parameter is valid only if AutoPay is set to true.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal for the GA instance. Valid values: true: yes. false (default): no.	false
AutoRenewDuration	integer	No	The auto-renewal duration. Unit: months. Valid values: 1 to 12. Default value: 1. Note This parameter is valid only if AutoRenew is set to true.	1
PromotionOptionNo	string	No	The coupon code. Note This parameter is available only on the international site (alibabacloud.com).	50003298014****
BandwidthBillingType	string	No	The bandwidth billing method. BandwidthPackage: billed based on bandwidth plans. CDT: pay-by-data-transfer.	BandwidthPackage
IpSetConfig	object	No	The configurations of the acceleration area.
AccessMode	string	No	The access mode of the acceleration area. Valid values: UserDefine: custom nearby access mode. You can select acceleration areas and regions as needed. GA assigns a separate EIP to each acceleration region. Anycast: automatic nearby access mode. You do not need to specify an acceleration area. GA selects an optimal acceleration region and assigns an Anycast EIP to the GA instance. Users can connect to the Alibaba Cloud network from the nearest access point.	UserDefine
ResourceGroupId	string	No	The ID of the resource group to which the standard GA instance belongs.	rg-aekzrnd67gq****
Tag	array<object>	No	The tags of the GA instance.
	object	No	The tags of the GA instance.
Key	string	No	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 start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the GA instance. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag values.	tag-value
InstanceChargeType	string	No	The billing method of the GA instance. PREPAY (default): subscription. POSTPAY: pay-as-you-go.	PREPAY
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.	false
Bandwidth	integer	No	The bandwidth of the standard GA instance. Unit: Mbps. Valid values: 200 to 5000. Note This parameter is required only when the access mode of the acceleration area is Anycast.	200

Response parameters

Parameter	Type	Description	Example
	object	The information returned.
RequestId	string	The request ID.	F591955F-5CB5-4CCE-A75D-17CF2085CE22
OrderId	string	The order ID. This parameter is returned when the value of InstanceChargeType (the billing method) is PREPAY (subscription). If AutoPay is set to false, you must go to the Order Hub to complete the payment.	208257****
AcceleratorId	string	The ID of the GA instance.	ga-bp17frjjh0udz4qz****

Examples

Success response

JSON format

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

Error codes

HTTP status code	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.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.