You can call this operation to modify the bandwidth settings and email address of a client account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | ModifySmartAccessGatewayClientUser |
The operation that you want to perform. Set the value to ModifySmartAccessGatewayClientUser. |
Bandwidth | Integer | Yes | 1 |
The bandwidth. Unit: Kbit/s. Maximum: 2,000 Kbit/s. |
RegionId | String | Yes | cn-shanghai |
The region where the Smart Access Gateway (SAG) APP instance is deployed. |
SmartAGId | String | Yes | sag-kdhej*******8 |
The ID of the SAG APP instance. |
UserName | String | Yes | doctest |
The username of the client account. Usernames of client accounts added to the same SAG APP instance are unique. For a client account, both the username and password are required. |
String | No | test@example.com |
The email address of the client account. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 5F0078B5-8AAD-4B53-8351-4C91B8EA528A |
The ID of the request. |
ClientIp | String | 10.**. **. ** |
The IP address of the client. |
UserMail | String | test@example.com |
The email address of the client account. |
UserName | String | doctes |
The name of the client. |
Bandwidth | Integer | 1 |
The desired bandwidth. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ModifySmartAccessGatewayClientUser
&Bandwidth=1
&RegionId=cn-shanghai
&SmartAGId=sag-kdhej*******8
&UserName=doctest
&<Common request parameters>
Sample success responses
XML
format
<ModifySmartAccessGatewayClientUserResponse>
<RequestId>5F0078B5-8AAD-4B53-8351-4C91B8EA528A</RequestId>
<UserMail>test@example.com</UserMail>
<UserName>doctes</UserName>
<Bandwidth>1</Bandwidth>
</ModifySmartAccessGatewayClientUserResponse>
JSON
format
{
"RequestId": "5F0078B5-8AAD-4B53-8351-4C91B8EA528A",
"UserMail": "test@example.com",
"UserName": "doctes",
"Bandwidth": 1
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | ClientUser.BandwidthInvalid | The specified Bandwidth is invalid. | The error message returned because the specified bandwidth 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 specified. |
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The error message returned because the specified SAG instance does not exist. |
For a list of error codes, visit the API Error Center.