CreateBasicAccelerator -

Description

Basic GA instances use high-quality global network bandwidth and the transmission network of Alibaba Cloud to provide users with point-to-point acceleration services. You can use basic GA instances to accelerate content delivery at Layer 3 (IP protocols). For more information, see Overview of standard GA instances.

The CreateBasicAccelerator operation is an asynchronous operation. After you send a request, the system returns the ID of a basic GA instance, but the operation is still being performed in the background. You can call the GetBasicAccelerator or ListBasicAccelerators operation to query the status of a basic GA instance:

If the basic GA instance is in the init state, it indicates 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	CreateBasicAccelerator	The operation that you want to perform. Set the value to CreateBasicAccelerator.
RegionId	String	Yes	cn-hangzhou	The ID of the region where you want to create the GA instance. Set the value to cn-hangzhou.
ClientToken	String	No	123e4567****	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 all requests. The ClientToken value 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.
Duration	Integer	No	1	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.
PricingCycle	String	No	Month	The billing cycle of the GA instance. Valid values: Month: billed on a monthly basis. Year: billed on an annual basis.
BandwidthBillingType	String	No	CDT	The bandwidth billing method. Valid values: BandwidthPackage: billed based on bandwidth plans. CDT: billed through Cloud Data Transfer (CDT) and based on data transfer. CDT95: billed through CDT and based on the 95th percentile bandwidth. This bandwidth billing method is available only for users that are included in the whitelist.
AutoPay	Boolean	No	false	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.
AutoUseCoupon	String	No	false	Specifies whether to automatically pay bills by using coupons. Default value: false. Valid values: true: automatically pays bills by using coupons. false: does not automatically pay bills by using coupons. Note This parameter is required only if AutoPay is set to true.
PromotionOptionNo	String	No	50003298014****	The coupon code. Note This parameter is only available on the international site.
AutoRenew	Boolean	No	false	Specifies whether to enable auto-renewal for the GA instance. Valid values: true: enable auto-renewal for the GA instance. false (default): does not enable auto-renewal for the GA instance.
AutoRenewDuration	Integer	No	1	The auto-renewal duration. Unit: months. Valid values: 1 to 12. Default value: 1. Note This parameter is required only if AutoRenew is set to true.
ResourceGroupId	String	No	rg-acfmxshhcsn****	The ID of the resource group to which the basic GA instance belongs.
ChargeType	String	No	PREPAY	The billing method. Set the value to PREPAY, which specifies the subscription billing method.
DryRun	Boolean	No	false	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 (default): 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.

Response parameters


Parameter	Type	Example	Description
RequestId	String	F591955F-5CB5-4CCE-A75D-17CF2085CE22	The ID of the request.
OrderId	String	2082574365	The ID of the order.
AcceleratorId	String	ga-bp17frjjh0udz4qz****	The ID of the basic GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBasicAccelerator
&RegionId=cn-hangzhou
&ClientToken=123e4567****
&Duration=1
&PricingCycle=Month
&BandwidthBillingType=CDT
&AutoPay=false
&AutoUseCoupon=false
&PromotionOptionNo=50003298014****
&AutoRenew=false
&AutoRenewDuration=1
&ResourceGroupId=rg-acfmxshhcsn****
&ChargeType=PREPAY
&DryRun=false
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBasicAcceleratorResponse>
    <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>
    <OrderId>2082574365</OrderId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
</CreateBasicAcceleratorResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes


HttpCode	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.	The error message returned because an error occurred while the request was being processed. Try again later.

For a list of error codes, see Service error codes.