调用DescribeSmartAccessGatewayClientUsers查询智能接入网关APP实例用户列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeSmartAccessGatewayClientUsers |
要执行的操作。 取值:DescribeSmartAccessGatewayClientUsers。 |
RegionId | String | 是 | cn-shanghai |
智能接入网关APP实例所在的地域。 |
SmartAGId | String | 是 | sag-jfkskjfjf******** |
智能接入网关APP实例ID。 |
UserName | String | 否 | doctest |
用户名,同一个智能接入网关APP实例下的用户名不可以重复。 |
PageNumber | Integer | 否 | 2 |
分页查询的页码。 |
PageSize | Integer | 否 | 21 |
分页查询时设置的每页行数。 最大值:100 默认值:10 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 62F4CF10-F909-487E-8E95-BC35457C5F50 |
请求ID。 |
TotalCount | Integer | 2 |
用户数。 |
PageNumber | Integer | 1 |
分页查询的页码。 |
PageSize | Integer | 12 |
分页查询时设置的每页行数。 最大值:100 默认值:10 |
Users | Array |
APP客户端用户信息。 |
|
ClientIp | String | 10.**.**.** |
软件版客户端的IP地址。 |
UserMail | String | test@example.com |
普通用户的邮箱地址。 |
UserName | String | doctest |
用户名。 |
Bandwidth | Integer | 2 |
带宽。 |
State | Integer | 0 |
账号启用状态,包含以下选项:
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeSmartAccessGatewayClientUsers
&RegionId=cn-shanghai
&SmartAGId=sag-jfkskjfjf********
&<公共请求参数>
正常返回示例
XML
格式
<DescribeSmartAccessGatewayClientUsersResponse>
<PageNumber>1</PageNumber>
<Users>
<User>
<State>0</State>
<UserMail>canrui.xxx@alibaba-inc.com</UserMail>
<UserName>wucanrui0212</UserName>
<Bandwidth>2000</Bandwidth>
</User>
<User>
<State>0</State>
<UserMail>canrui.xxx@alibaba-inc.com</UserMail>
<UserName>wucanrui0211</UserName>
<Bandwidth>2000</Bandwidth>
</User>
<User>
<State>0</State>
<UserMail>olly.xxx@alibaba-inc.com</UserMail>
<UserName>shuanghong001</UserName>
<Bandwidth>2000</Bandwidth>
</User>
</Users>
<TotalCount>3</TotalCount>
<PageSize>10</PageSize>
<RequestId>41DFF941-51CE-44E0-B633-5F684AA11757</RequestId>
</DescribeSmartAccessGatewayClientUsersResponse>
JSON
格式
{
"PageNumber": 1,
"Users": {
"User": [
{
"State": 0,
"UserMail": "canrui.xxx@alibaba-inc.com",
"UserName": "wucanrui0212",
"Bandwidth": 2000
},
{
"State": 0,
"UserMail": "canrui.xxx@alibaba-inc.com",
"UserName": "wucanrui0211",
"Bandwidth": 2000
},
{
"State": 0,
"UserMail": "olly.xxx@alibaba-inc.com",
"UserName": "shuanghong001",
"Bandwidth": 2000
}
]
},
"TotalCount": 3,
"PageSize": 10,
"RequestId": "41DFF941-51CE-44E0-B633-5F684AA11757"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | 智能网关实例ID为空。 |
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能网关实例不存在。 |
访问错误中心查看更多错误码。