AssociateSmartAGWithApplicationBandwidthPackage - Smart Access Gateway

Associates a bandwidth plan for application acceleration with a Smart Access Gateway (SAG) instance.

Operation description

Before you associate a bandwidth plan for application acceleration with an SAG instance, make sure that the following requirements are met:

If you want to associate a bandwidth plan for application acceleration with an SAG CPE instance, the version of the SAG device associated with the SAG CPE instance must be 2.4.0 or later.

If the version of the SAG device is earlier than 2.4.0, update it. For more information, see Update the version of an SAG device.
If you want to associate a bandwidth plan for application acceleration with an SAG app instance, the version of the SAG app must be 2.4.0 or later.

If the version of the SAG app is earlier than 2.4.0, update it. For more information, see Install the SAG app.
The SAG instance to be associated is in the available state.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:AssociateSmartAGWithApplicationBandwidthPackage		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DryRun	boolean	No	Specifies whether to precheck the request. Check items include permissions and the status of the specified cloud resources. Valid values: false (default): sends the request. After the request passes the check, the bandwidth plan for application acceleration is associated with the SAG instance. true: prechecks the request but does not associate the bandwidth plan for application acceleration with the SAG instance. 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.	false
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 make sure that it is unique among different requests. The token can contain only ASCII characters. 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.	02fb3da4-130e-11e9-8e44-001****
RegionId	string	Yes	The region ID of the bandwidth plan for application acceleration. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
ApplicationBandwidthPackageId	string	Yes	The ID of the bandwidth plan for application acceleration.	abwp-7963l7iqnquyj3****
AssociateConfigs	array<object>	Yes	The configuration of application acceleration.
	object	Yes
SmartAGId	string	Yes	The ID of the SAG instance.	sag-gf5serujbhrn2j****
Bandwidth	integer	Yes	The maximum bandwidth value for application acceleration. Unit: Mbit/s. Note The maximum bandwidth value of each SAG instance cannot exceed that of the associated bandwidth plan for application acceleration.	2

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	AFF2FD9D-66BD-4DD4-8152-C4508119D7B1

Examples

Sample success responses

JSONformat

{
  "RequestId": "AFF2FD9D-66BD-4DD4-8152-C4508119D7B1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedFeature.ApplicationAccelerate	The feature of ApplicationAccelerate is not supported.	Application acceleration is not supported.
400	ResourceNotFound.ApplicationBandwidthPackage	The specified resource of ApplicationBandwidthPackage is not found.	-
400	OperationDenied.NoBindCcn	The CCN is not associated. The operation is denied.	The operation has been denied because the resource e is not associated with a CCN instance.
400	OperationDenied.Arrearage	The operation is denied due to overdue payment.	The operation has been denied due to overdue payments.
400	IncorrectBusinessStatus.ApplicationBandwidthPackage	The business status of ApplicationBandwidthPackage is incorrect.	The status of the application acceleration bandwidth plan is invalid.
400	ResourceAlreadyAssociated.SmartAccessGateway	The specified resource of SmartAccessGateway is already associated.	The resource is already associated with the specified SAG instance.
404	ResourceNotFound.SmartAccessGateway	The specified resource of SmartAccessGateway is not found.	-

For a list of error codes, visit the Service error codes.