文档

DescribeSmartAccessGatewayClientUsers - 查询智能接入网关APP实例用户列表

更新时间:

调用DescribeSmartAccessGatewayClientUsers查询智能接入网关APP实例下的客户端账号信息。

调试

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

授权信息

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

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

请求参数

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

智能接入网关 App 实例所属的地域 ID。

cn-shanghai
SmartAGIdstring

智能接入网关 App 实例 ID。

sag-kzo5dvms3dqii3*****
UserNamestring

客户端的用户名。

username
PageNumberinteger

查询页码。默认值:1

1
PageSizeinteger

分页查询时每页的条目数。默认值:10

10
UserMailstring

客户端的邮箱地址。

username@example.com

返回参数

名称类型描述示例值
object

查询结果。

TotalCountinteger

列表条目数。

1
PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

62F4CF10-F909-487E-8E95-BC35457C5F50
PageNumberinteger

查询页码。

1
Usersobject []

客户端账号信息列表。

Bandwidthinteger

客户端可使用的上云带宽。单位:Kbps。

2000
Stateinteger

客户端的启用状态:

  • 0:表示启用该客户端。

  • 1:表示禁用该客户端。

1
ClientIpstring

系统为客户端分配的 IP 地址。

10.10.10.1
UserNamestring

客户端的用户名。

username
UserMailstring

客户端的邮箱地址。

username@example.com
AccelerateBandwidthlong

客户端可使用的应用加速带宽峰值。单位:Kbps。

1000
IsStaticIplong

客户端的 IP 地址是否为固定 IP 地址。

  • 1:是。

  • 0:否。

0

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "62F4CF10-F909-487E-8E95-BC35457C5F50",
  "PageNumber": 1,
  "Users": {
    "User": [
      {
        "Bandwidth": 2000,
        "State": 1,
        "ClientIp": "10.10.10.1",
        "UserName": "username",
        "UserMail": "username@example.com",
        "AccelerateBandwidth": 1000,
        "IsStaticIp": 0
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.智能接入网关实例ID为空。
400SAG.InstanceNoFoundThe specified SAG instance does not exist.智能接入网关实例不存在。

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