All Products
Search
Document Center

Global Accelerator:CreateBasicAccelerator

Last Updated:Mar 26, 2024

Basic Global Accelerator (GA) instances leverage the immense bandwidth of the high-quality global network of Alibaba Cloud to provide end-to-end acceleration services. You can use basic GA instances to accelerate content delivery at Layer 3 (IP). You can call the CreateBasicAccelerator operation to create a basic GA instance.

Operation description

CreateBasicAccelerator is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetBasicAccelerator or ListBasicAccelerators operation to query the status of the task.

  • If the basic GA instance is in the init state, it indicates that the basic GA instance is being created. In this case, you can perform only query operations.
  • If the basic GA instance is in the active state, it indicates that the basic 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:CreateBasicAcceleratorWrite
  • BasicAccelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the basic GA instance is deployed. 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 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****
DurationintegerNo

The subscription duration of the GA instance.

  • If you set PricingCycle to Month, the valid values for Duration are 1 to 9.
  • If you set PricingCycle to Year, the valid values for Duration are 1 to 3.
1
PricingCyclestringNo

The billing cycle. Valid values:

  • Month
  • Year
Month
BandwidthBillingTypestringNo

The bandwidth billing method. Valid values:

  • BandwidthPackage: billed based on bandwidth plans.
  • CDT: billed based on data transfer. The bills are managed by using Cloud Data Transfer (CDT).
  • CDT95: billed based on the 95th percentile bandwidth. The bills are managed by using Cloud Data Transfer (CDT). This bandwidth billing method is not available by default. Contact your Alibaba Cloud account manager for more information.
CDT
AutoPaybooleanNo

Specifies whether to enable automatic payment. 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. This is the default value.
  • true: enables automatic payment. Payments are automatically completed.
false
AutoUseCouponstringNo

Specifies whether to automatically apply coupons to your bills. Valid values:

  • true: automatically applies coupons to your bills.
  • false: does not automatically apply coupons to your bills. This is the default value.
Note This parameter takes effect only when the AutoPay parameter is set to true.
false
PromotionOptionNostringNo

The code of the coupon.

Note This parameter takes effect only for accounts registered on the international site (alibabacloud.com).
50003298014****
AutoRenewbooleanNo

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

  • true: enables auto-renewal for the basic GA instance.
  • false: disables auto-renewal for the basic GA instance. This is the default value.
false
AutoRenewDurationintegerNo

The auto-renewal duration. Unit: months.

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

Note This parameter takes effect only when the AutoPay parameter is set to true.
1
ResourceGroupIdstringNo

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

rg-acfmxshhcsn****
ChargeTypestringNo

The billing method. Valid values:

  • PREPAY (default)
  • POSTPAY
PREPAY
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and 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: performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed. This is the default value.
false
Tagobject []No

The tags of the basic GA instance.

KeystringNo

The tag key. 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://. The tag key cannot start with aliyun or acs:.

You can specify up to 20 tag keys.

tag-key
ValuestringNo

The tag value. 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 acs: or aliyun.

You can specify up to 20 tag values.

tag-value

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The order ID.

This parameter is returned only if ChargeType is set to PREPAY.

If AutoPay is set to false, go to Order Center to complete the payment after an order is generated.

2082574365
AcceleratorIdstring

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****

Examples

Sample success responses

JSONformat

{
  "RequestId": "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "OrderId": "2082574365",
  "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-04-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
2023-04-10The 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