Disables online connections based on the ID of the Smart Access Gateway (SAG) APP instance and username.
Debug
Use OpenAPI Explorer to perform debug operations and generate SDK code examples.
Request parameters
| Parameter | Type | Required? | Example value | Description |
|---|---|---|---|---|
| RegionId | String | Yes | cn-shanghai |
The ID of the region to which the SAG APP instance belongs. |
| SmartAGId | String | Yes | sag-ehjfb******* |
The ID of the SAG APP instance. |
| Username | String | Yes | doctest |
The username. Usernames associated with the same SAG APP instance must be unique. The username and password are mutually dependent. If one is specified, the other must also be specified. |
| Action | String | No | KickOutClients |
The name of this action. Value: KickOutClients |
Response parameters
| Parameter | Type | Example value | Description |
|---|---|---|---|
| RequestId | String | 76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E |
The ID of the request. |
Examples
Request example
http(s)://[Endpoint]/? Action=KickOutClients
&RegionId=cn-shanghai
&SmartAGId=sag-ehjfb*******
&Username=doctest
&<CommonParameters>
Response example
XML format
<KickOutClientsResponse>
<RequestId>7108A98F-C47D-45F7-A4D8-C2E3022735DA</RequestId>
</KickOutClientsResponse>
JSON format
{
"RequestId":"7108A98F-C47D-45F7-A4D8-C2E3022735DA"
}Errors
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ClientUser.NameEmpty | You must specify UserName. | The username cannot be empty. |
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The specified SAG instance does not exist. |
For a list of error codes, visit the API Error Center.