You can call this operation to disconnect a client from Alibaba Cloud based on the ID of the Smart Access Gateway (SAG) APP instance and username of the client account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
RegionId | String | Yes | cn-shanghai |
The region where the SAG APP instance is deployed. |
SmartAGId | String | Yes | sag-ehjfb******* |
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, if you specify the username, you must also specify the password. |
Action | String | No | KickOutClients |
The operation that you want to perform. Set the value to KickOutClients. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=KickOutClients
&RegionId=cn-shanghai
&SmartAGId=sag-ehjfb*******
&Username=doctest
&<Common request parameters>
Sample success responses
XML
format
<KickOutClientsResponse>
<RequestId>7108A98F-C47D-45F7-A4D8-C2E3022735DA</RequestId>
</KickOutClientsResponse>
JSON
format
{
"RequestId":"7108A98F-C47D-45F7-A4D8-C2E3022735DA"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | ClientUser.NameEmpty | You must specify UserName. | The error message returned because the username 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.