You can call this operation to create a client account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | CreateSmartAccessGatewayClientUser |
The operation that you want to perform. Set the value to CreateSmartAccessGatewayClientUser. |
Bandwidth | Long | Yes | 20 |
The bandwidth. Unit: Kbit/s. Maximum bandwidth: 2,000 Kbit/s. |
RegionId | String | Yes | cn-shanghai |
The region where the SAG APP instance is deployed. |
SmartAGId | String | Yes | sag-gnhe6sywtare5****** |
The ID of the SAG APP instance. |
UserMail | String | Yes | test@example.com |
The email address of the user. The username and password are sent to the specified email address. |
UserName | String | No | doctest |
The username of the client account. Usernames of client accounts added to the same SAG APP instance must be unique. For a client account, if you specify the username, you must also specify the password. |
ClientIp | String | No | 10.**. **. ** |
|
Password | String | No | duuf** |
The password used to log on to SAG APP. For a client account, if you specify the username, you must also specify the password. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7 |
The ID of the request. |
ClientIp | String | 10.**. *. ** |
The IP address of SAG APP. |
UserMail | String | test@example.com |
The email address of the user. |
UserName | String | doc |
The username of the client account. Usernames of client accounts added to the same SAG APP instance must be unique. |
Bandwidth | Integer | 2 |
The bandwidth for the client account. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=CreateSmartAccessGatewayClientUser
&Bandwidth=20
&RegionId=cn-shanghai
&SmartAGId=sag-gnhe6sywtare5******
&UserMail=test@example.com
&<Common request parameters>
Sample success responses
XML
format
<CreateSmartAccessGatewayClientUserResponse>
<RequestId>72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7</RequestId>
<UserMail>dd@example.com</UserMail>
<UserName>dd@example.com</UserName>
<Bandwidth>2</Bandwidth>
</CreateSmartAccessGatewayClientUserResponse>
JSON
format
{
"RequestId": "72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7",
"UserMail": "dd@example.com",
"UserName": "dd@example.com",
"Bandwidth": 2
}
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.EmailEmpty | You must specify UserEmail. | The error message returned because the email address of the client account is not specified. |
400 | ClientUser.EmailInvalid | The format of the specified UserEmail is invalid. | The error message returned because the format of the specified email address is invalid. |
400 | ClientUser.InvalidClientIp | The specified ClientIp is invalid. | The error message returned because the specified client IP address is invalid. |
400 | ClientUser.IpEmpty | You must specify ClientIp. | The error message returned because no static IP address is configured. |
400 | ClientUser.IpInvalid | The specified ClientIp is invalid. | The error message returned because the specified static IP address 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 | ClientUser.UserExist | The specified user already exists. | The error message returned because the specified client account already exists. |
400 | ClientUser.UserOverLimit | The maximum number of users is exceeded. | The error message returned because the number of client accounts added to the SAG APP instance has reached the upper limit. |
400 | SAG.CidrEmpty | You must specify the CIDR blocks of SAG. | The error message returned because the CIDR block of the SAG APP instance is not specified. |
400 | ClientUser.PasswordInvalid | The specified password format is invalid. | The error message returned because the format of the specified password is invalid. |
For a list of error codes, visit the API Error Center.