调用DescribeUserOnlineClients查询用户在线连接列表_智能接入网关(SAG)-阿里云帮助中心

根据用户名和智能接入网关APP实例ID查询指定用户在线连接列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
smartag:DescribeUserOnlineClients	Read	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	智能接入网关 APP 实例所在的地域。	cn-shanghai
SmartAGId	string	是	智能接入网关 APP 实例 ID。	sag-wfjgn**********
UserName	string	是	用户名，同一个智能接入网关 APP 实例下的用户名不可以重复。用户名和密码相互依赖，若指定用户名则必须指定密码，反之，若指定密码则必须指定用户名。	doctest

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7108A98F-C47D-45F7-A4D8-C2E3022735DA
Users	object []	用户信息。
ClientIp	string	阿里云 APP 客户端 IP。	10...**
OnlineTime	string	上线时间。	1559125519

示例

正常返回示例

JSON格式

{
  "RequestId": "7108A98F-C47D-45F7-A4D8-C2E3022735DA",
  "Users": {
    "User": [
      {
        "ClientIp": "10.**.**.**",
        "OnlineTime": "1559125519"
      }
    ]
  }
}

JSON格式

{
  "RequestId": "7108A98F-C47D-45F7-A4D8-C2E3022735DA",
  "Users": {
    "User": [
      {
        "ClientIp": "10.**.**.**",
        "OnlineTime": "1559125519"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ClientUser.NameEmpty	You must specify UserName.	用户名不能为空。
400	ClientUser.NameInvalid	The specified UserName is invalid.	用户名格式非法。
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	智能接入网关实例ID为空。
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。

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