文档

DescribeUserOnlineClientStatistics - 查询APP实例用户在线连接统计数

更新时间:

查询指定智能接入网关APP实例下指定用户的在线连接统计数。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-shanghai
SmartAGIdstring

智能接入网关 APP 实例 ID。

sag-sfjg*****
UserNamesarray

用户名列表,多个用户用“,”隔开,最多可同时查询 50 个用户信息。

string

用户名。

doctest

返回参数

名称类型描述示例值
object
UserStatisticsobject []

指定用户在线连接信息。

OnlineCountstring

在线连接数。

2
UserNamestring

用户名。

doctest
RequestIdstring

请求 ID。

14846A6A-2192-4F6A-B272-B8BD68EBC89B

示例

正常返回示例

JSON格式

{
  "UserStatistics": {
    "Statistics": [
      {
        "OnlineCount": "2",
        "UserName": "doctest"
      }
    ]
  },
  "RequestId": "14846A6A-2192-4F6A-B272-B8BD68EBC89B"
}

错误码

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

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