Creates a Global Accelerator (GA) instance. GA is a high-availability and high-performance network acceleration service for global users. By leveraging the high-quality BGP bandwidth and global network of Alibaba Cloud, GA allows service providers to deploy applications across regions and users to connect to the nearest access points for content delivery acceleration. This reduces network issues, such as network latency, network jitters, and packet loss.
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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ga:CreateAccelerator | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region in which to create the GA instance. 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 use the client to generate the token, but you must make sure that the token is unique among different requests. The client 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 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 |
Duration | integer | No | The subscription duration of the GA instance.
Note
If the InstanceChargeType parameter is set to PREPAY, you must configure this parameter.
| 1 |
PricingCycle | string | No | The billing cycle of the GA instance. Valid values:
Note
If the InstanceChargeType parameter is set to PREPAY, you must configure this parameter.
| Month |
Spec | string | No | The type of the GA instance. Valid values:
Note
Different specifications provide different capabilities. For more information, see Instance type. | 1 |
AutoPay | boolean | No | Specifies whether to enable automatic payment. Default value: false. Valid values:
| false |
AutoUseCoupon | string | No | Specifies whether to automatically use coupons when making payments. Default value: false. Valid values:
Note
This parameter takes effect only when AutoPay is set to true.
| false |
AutoRenew | boolean | No | Specifies whether to enable auto-renewal for the GA instance. Default value: false. Valid values:
| false |
AutoRenewDuration | integer | No | 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 |
PromotionOptionNo | string | No | The coupon code. | 50003298014**** |
BandwidthBillingType | string | No | The bandwidth billing method.
| BandwidthPackage |
IpSetConfig | object | No | The configurations of the acceleration area. | |
AccessMode | string | No | The access mode of the acceleration area. Valid values:
| 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 contain You can specify up to 20 tag keys. | tag-key |
Value | string | No | 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 You can specify up to 20 tag values. | tag-value |
InstanceChargeType | string | No | The billing method of the GA instance.
| PREPAY |
DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
Response parameters
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-06-13 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-04-20 | The Error code has changed | View Change Details |
2023-03-31 | The Error code has changed. The request parameters of the API has changed | View Change Details |