Associates a bandwidth plan with a Global Accelerator (GA) instance.

Description

  • BandwidthPackageAddAccelerator is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the DescribeBandwidthPackage operation to query the state of the bandwidth plan that you attempt to associate.
    • If the bandwidth plan is in the binding state, it indicates that the bandwidth plan is being associated. In this case, you can perform only query operations.
    • If the bandwidth plan is in the active state, it indicates that the bandwidth plan is associated.
  • The BandwidthPackageAddAccelerator operation cannot be called repeatedly for the same GA instance.

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 BandwidthPackageAddAccelerator

The operation that you want to perform. Set the value to BandwidthPackageAddAccelerator.

RegionId String Yes cn-hangzhou

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

BandwidthPackageId String Yes gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

AcceleratorId String Yes ga-bp1qe94o52ot4pkfn****

The ID of the GA instance.

Response parameters

Parameter Type Example Description
RequestId String B7770CB9-9745-4FE5-9EDA-D14B01A12A50

The ID of the request.

Accelerators Array of String ga-bp1qe94o52ot4pkfn****

The ID of the GA instance.

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

Examples

Sample requests

http(s)://[Endpoint]/?Action=BandwidthPackageAddAccelerator
&RegionId=cn-hangzhou
&BandwidthPackageId=gbwp-bp1sgzldyj6b4q7cx****
&AcceleratorId=ga-bp1qe94o52ot4pkfn****
&<Common request parameters>

Sample success responses

XML format 

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

<BandwidthPackageAddAcceleratorResponse>
    <RequestId>B7770CB9-9745-4FE5-9EDA-D14B01A12A50</RequestId>
    <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>
    <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>
</BandwidthPackageAddAcceleratorResponse>

JSON format 

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

{
  "RequestId" : "B7770CB9-9745-4FE5-9EDA-D14B01A12A50",
  "Accelerators" : [ "ga-bp1qe94o52ot4pkfn****" ],
  "BandwidthPackageId" : "gbwp-bp1sgzldyj6b4q7cx****"
}

Error codes

HttpCode Error code Error message Description
400 NotExist.BandwidthPackage The bandwidth package does not exist. The error message returned because the specified bandwidth plan does not exist.
400 StateError.BandwidthPackage The state of bandwidth package is invalid. The error message returned because the specified bandwidth plan is in an invalid state.
400 NotExist.BasicBandwidthPackage You must specify the basic bandwidth package. The error message returned because no basic bandwidth plan is specified.

For a list of error codes, visit the API Error Center.