Build a Basic GA Instance with the CreateBasicAccelerator API - Global Accelerator - Alibaba Cloud - Global Accelerator

Creates a basic Global Accelerator (GA) instance. Basic GA instances rely on Alibaba Cloud's premium global Internet bandwidth and high-quality transmission networks to provide point-to-point acceleration. They are primarily used for Layer 3 (IP protocol) network acceleration. You can call the CreateBasicAccelerator operation to create a basic GA instance.

Operation description

The CreateBasicAccelerator operation is asynchronous. The system first returns the ID of the basic Global Accelerator (GA) instance, but the instance is not yet created and the creation task is still running in the background. You can call GetBasicAccelerator or ListBasicAccelerators to query the status of the basic GA instance:

When the basic GA instance is in the init state, the instance is being created. In this state, you can only perform query operations.
When the basic GA 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 supports 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:CreateBasicAccelerator

create

*BasicAccelerator

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the basic 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 value, but you must ensure that it 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 RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567****
Duration	integer	No	The purchase duration. If PricingCycle is set to Month, valid values for Duration are 1 to 9. If PricingCycle is set to Year, valid values for Duration are 1 to 3.	1
PricingCycle	string	No	The billing cycle. Valid values: Month: monthly billing. Year: yearly billing. Valid values: Month : monthly billing. Year : yearly billing. Hour : hourly billing. Day : daily billing.	Month
BandwidthBillingType	string	No	The bandwidth billing method. Valid values: BandwidthPackage: billed by bandwidth plan. CDT: billed by traffic and settled uniformly by Cloud Data Transfer (CDT). CDT95: billed based on the 95th percentile bandwidth and settled uniformly by CDT. This bandwidth billing method is available only to whitelisted users.	CDT
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false (default): Automatic payment is disabled. After an order is generated, you must go to the Order Center to complete the payment. true: Automatic payment is enabled and the order is automatically paid.	false
AutoUseCoupon	string	No	Specifies whether to use coupons for automatic payment of bills. Valid values: true: yes. false (default): no. Note This parameter takes effect only when AutoPay is set to true.	false
PromotionOptionNo	string	No	The coupon code. Note This parameter is applicable only to the international site.	50003298014****
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. 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 takes effect only when AutoRenew is set to true.	1
ResourceGroupId	string	No	The ID of the resource group to which the basic GA instance belongs.	rg-acfmxshhcsn****
ChargeType	string	No	The billing method. Valid values: 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 and does not create the resource. The system checks whether required parameters are specified, the 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): performs a normal request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	false
Tag	array<object>	No	The tags of the basic GA instance.
	object	No	The tags of the basic GA instance.
Key	string	No	The tag key of the basic 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:, or contain http:// or https://. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the basic GA instance. The tag value cannot be an empty string. The tag value can be up to 128 characters in length, and cannot start with aliyun or acs:, or contain http:// or https://. You can specify up to 20 tag values.	tag-value

Response elements

Element	Type	Description	Example
	object	The returned information.
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
OrderId	string	The order ID. This parameter is returned when ChargeType is set to PREPAY. If AutoPay is set to false, which means automatic payment is disabled, go to the Order Center to complete the payment.	2082574365
RequestId	string	The request ID.	F591955F-5CB5-4CCE-A75D-17CF2085CE22

Examples

Success response

JSON format

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

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.