调用KickOutClients根据智能接入网关APP实例ID和用户名,剔除在线连接。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-shanghai

智能接入网关APP实例所在的地域。

SmartAGId String sag-ehjfb*******

智能接入网关APP实例ID。

Username String doctest

用户名,同一个智能接入网关APP实例下的用户名不可以重复。

用户名和密码相互依赖,若指定用户名则必须指定密码,反之,若指定密码则必须指定用户名。

Action String KickOutClients

要执行的操作。

取值:KickOutClients

返回数据

名称 类型 示例值 描述
RequestId String 76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E

请求ID。

示例

请求示例


http(s)://[Endpoint]/?Action=KickOutClients
&RegionId=cn-shanghai
&SmartAGId=sag-ehjfb*******
&Username=doctest
&<公共请求参数>

正常返回示例

XML 格式

<KickOutClientsResponse>
	  <RequestId>7108A98F-C47D-45F7-A4D8-C2E3022735DA</RequestId>
    </KickOutClientsResponse>

JSON 格式

{
	"RequestId":"7108A98F-C47D-45F7-A4D8-C2E3022735DA"
}

错误码

HttpCode 错误码 错误信息 描述
400 ClientUser.NameEmpty You must specify UserName. 用户名不能为空。
400 SAG.InstanceNoFound The specified SAG instance does not exist. 智能网关实例不存在。

访问错误中心查看更多错误码。