Modifies the maximum bandwidth for application acceleration of client accounts on Smart Access Gateway (SAG) app.
Operation description
Before you set a maximum bandwidth value for a client, take note of the following rules:
- The maximum bandwidth value of a client cannot exceed that of the SAG app instance to which the client belongs.
- If you have not set maximum bandwidth values for clients that belong to an SAG app instance, and the maximum bandwidth value of the instance is less than 5 Mbit/s, for example, 4 Mbit/s, the maximum bandwidth value of each client that belongs to the SAG app instance is 4 Mbit/s by default.
- If you have not set maximum bandwidth values for clients that belong to an SAG app instance, and the maximum bandwidth value of the instance is 5 Mbit/s or higher, the maximum bandwidth value of each client that belongs to the SAG app instance is 5 Mbit/s by default.
Debugging
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 Resourcesis 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:UpdateSmartAGUserAccelerateConfig | *SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DryRun | boolean | No | Specifies whether to perform a precheck to check information such as the permissions and instance status. Valid values:
| 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 ID of the region where the SAG app instance is deployed. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
| SmartAGId | string | Yes | The ID of the SAG app instance. | sag-w11hk4bqxpakem**** |
| UserName | string | Yes | The username of the client account. | username@example.com |
| Bandwidth | integer | Yes | The maximum bandwidth value for the client. Unit: Kbit/s. | 1000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "465B5F94-C7CF-4D54-803D-A7BEAC8545D6"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ResourceNotFound.User | The specified user is not found. | The specified user does not exist. |
| 400 | OperationDenied.BandwidthExceeded | The total bandwidth exceeds the limit. The operation is denied. | The operation has been denied because the bandwidth exceeds the upper limit. |
| 404 | ResourceNotFound.SmartAccessGateway | The specified resource of %s is not found. | The specified SAG instance does not exist. |
For a list of error codes, visit the Service error codes.