Modifies the bandwidth value and email address of a client.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | ModifySmartAccessGatewayClientUser |
The operation that you want to perform. Set the value to ModifySmartAccessGatewayClientUser. |
RegionId | String | Yes | cn-shanghai |
The region ID of the SAG app instance. You can call the DescribeRegions operation to query the most recent region list. |
SmartAGId | String | Yes | sag-rz2e23c0e78ema**** |
The ID of the SAG app instance. |
UserName | String | Yes | doctest |
The username of the client. |
Bandwidth | Integer | Yes | 1 |
The bandwidth that can be used by the client. Unit: Kbit/s. Valid values: 1 to 5000. |
String | No | username@example.com |
The email address of the client. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
UserName | String | doctest |
The username of the client. |
RequestId | String | 5F0078B5-8AAD-4B53-8351-4C91B8EA528A |
The ID of the request. |
UserMail | String | username@example.com |
The email address of the client. |
Bandwidth | Integer | 1 |
The bandwidth that can be used by the client. Unit: Kbit/s. |
ClientIp | String | 10.10.10.1 |
The IP address of the client. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ModifySmartAccessGatewayClientUser
&RegionId=cn-shanghai
&SmartAGId=sag-rz2e23c0e78ema****
&UserName=doctest
&Bandwidth=1
&Email=username@example.com
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifySmartAccessGatewayClientUserResponse>
<RequestId>5F0078B5-8AAD-4B53-8351-4C91B8EA528A</RequestId>
<UserMail>username@example.com</UserMail>
<UserName>doctest</UserName>
<Bandwidth>1</Bandwidth>
</ModifySmartAccessGatewayClientUserResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "5F0078B5-8AAD-4B53-8351-4C91B8EA528A",
"UserMail" : "username@example.com",
"UserName" : "doctest",
"Bandwidth" : 1
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | ClientUser.BandwidthInvalid | The specified Bandwidth is invalid. | The error message returned because the bandwidth specified for the client account is invalid. |
400 | ClientUser.NameEmpty | You must specify UserName. | The error message returned because the username is not specified. |
400 | ClientUser.NameInvalid | The specified UserName is invalid. | The error message returned because the format of the username is invalid. |
400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | The error message returned because the ID of the SAG instance is not set. |
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The error message returned because the specified SAG instance does not exist. |
400 | ResourceNotFound.User | The specified user is not found. | The error message returned because the specified user does not exist. |
For a list of error codes, visit the API Error Center.