DescribeSmartAccessGatewayClientUsers查询智能接入网关APP实例用户列表-智能接入网关-阿里云-智能接入网关(SAG)-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

smartag:DescribeSmartAccessGatewayClientUsers

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	智能接入网关 App 实例所属的地域 ID。	cn-shanghai
SmartAGId	string	是	智能接入网关 App 实例 ID。	sag-kzo5dvms3dqii3*****
UserName	string	否	客户端的用户名。	username
PageNumber	integer	否	查询页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的条目数。默认值：10。	10
UserMail	string	否	客户端的邮箱地址。	username@example.com

返回参数

名称	类型	描述	示例值
	object	查询结果。
TotalCount	integer	列表条目数。	1
PageSize	integer	分页查询时每页的条目数。	10
RequestId	string	请求 ID。	62F4CF10-F909-487E-8E95-BC35457C5F50
PageNumber	integer	查询页码。	1
Users	object
User	array<object>	客户端账号信息列表。
	object	客户端账号信息。
Bandwidth	integer	客户端可使用的上云带宽。单位：Kbps。	2000
State	integer	客户端的启用状态： 0：表示启用该客户端。 1：表示禁用该客户端。	1
ClientIp	string	系统为客户端分配的 IP 地址。	10.10.10.1
UserName	string	客户端的用户名。	username
UserMail	string	客户端的邮箱地址。	username@example.com
AccelerateBandwidth	integer	客户端可使用的应用加速带宽峰值。单位：Kbps。	1000
IsStaticIp	integer	客户端的 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	错误码	错误信息	描述
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	智能接入网关实例ID为空。
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。

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

变更历史

更多信息，参考变更详情。