Adds an application acceleration rule.

Usage notes

For each bandwidth plan for application acceleration, the sum of bandwidth values that you specify for different application acceleration rules cannot exceed the maximum bandwidth value of the bandwidth plan for application acceleration.

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 CreateApplicationAccelerationRule

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

DryRun Boolean No false

Specifies whether to perform a precheck to check information such as the permissions and instance status. Valid values:

  • false (default): sends the request. After the request passes the check, the application acceleration rule is added.
  • true: prechecks the request but does not add the application acceleration rule. If you use this value, the system checks the required parameters and the request syntax. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
ClientToken String No 02fb3da4-130e-11e9-8e44-001****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate a token, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
RegionId String Yes cn-shanghai

The region ID of the bandwidth plan for application acceleration.

You can call the DescribeRegions operation to query the most recent region list.

ApplicationBandwidthPackageId String Yes abwp-7963l7iqnquyj3****

The ID of the bandwidth plan for application acceleration.

AccelerationRules.N.ServiceRegionId String Yes cn-hongkong

The ID of the service region, which is the region ID of the applications.

You can call the DescribeRegions operation to query the most recent region list.

You can specify region IDs for at most 200 application acceleration rules in each call.

AccelerationRules.N.Bandwidth Integer Yes 1

The maximum bandwidth value of the application acceleration rule. Unit: Mbit/s.

You can specify maximum bandwidth values for at most 200 application acceleration rules in each call.

AccelerationRules.N.Applications.N String Yes O365

The applications that you want to accelerate.

You can call the ListAccelerateApplications operation to query the information about applications that can be accelerated by Smart Access Gateway (SAG).

You can specify applications for at most 200 application acceleration rules in each call.

Response parameters

Parameter Type Example Description
RequestId String 57626BB9-8EF0-4A41-AE60-2C097784365F

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateApplicationAccelerationRule
&DryRun=false
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&RegionId=cn-shanghai
&ApplicationBandwidthPackageId=abwp-7963l7iqnquyj3****
&AccelerationRules=[{"ServiceRegionId":"cn-hongkong","Bandwidth":1,"Applications":["O365"]}]
&<Common request parameters>

Sample success responses

XML format 

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

<CreateApplicationAccelerationRuleResponse>
    <RequestId>57626BB9-8EF0-4A41-AE60-2C097784365F</RequestId>
</CreateApplicationAccelerationRuleResponse>

JSON format 

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

{
  "RequestId" : "57626BB9-8EF0-4A41-AE60-2C097784365F"
}

Error codes

HttpCode Error code Error message Description
400 OperationDenied.Arrearage The operation is denied due to overdue payment. The error message returned because the operation is denied due to overdue payments.
400 OperationDenied.BandwidthExceeded The total bandwidth exceeds the limit. The operation is denied. The error message returned because the sum of maximum bandwidth values has reached the upper limit and the operation is denied.
400 UnsupportedFeature.ApplicationAccelerate The feature of ApplicationAccelerate is not supported. The error message returned because application acceleration is not supported.
400 ResourceAlreadyAssociated.SmartAccessGateway The specified resource of SmartAccessGateway is already associated. The error message returned because the specified SAG instance is already associated with an application acceleration rule.
400 IncorrectBusinessStatus.ApplicationBandwidthPackage The business status of ApplicationBandwidthPackage is incorrect. The error message returned because the specified bandwidth plan for application acceleration is in an invalid state.

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