All Products
Search
Document Center

Smart Access Gateway:UpdateSmartAGUserAccelerateConfig

Last Updated:Mar 29, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DryRunbooleanNo

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 maximum bandwidth value of the client is modified.
  • true: prechecks the request but does not modify the maximum bandwidth value of the client. 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
ClientTokenstringNo

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****
RegionIdstringYes

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
SmartAGIdstringYes

The ID of the SAG app instance.

sag-w11hk4bqxpakem****
UserNamestringYes

The username of the client account.

username@example.com
BandwidthintegerYes

The maximum bandwidth value for the client. Unit: Kbit/s.

1000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

465B5F94-C7CF-4D54-803D-A7BEAC8545D6

Examples

Sample success responses

JSONformat

{
  "RequestId": "465B5F94-C7CF-4D54-803D-A7BEAC8545D6"
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.UserThe specified user is not found.The specified user does not exist.
400OperationDenied.BandwidthExceededThe total bandwidth exceeds the limit. The operation is denied.The operation has been denied because the bandwidth exceeds the upper limit.
404ResourceNotFound.SmartAccessGatewayThe 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.