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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeSmartAccessGatewayClientUsers

要执行的操作。取值：DescribeSmartAccessGatewayClientUsers。

RegionId String 是 cn-shanghai

智能接入网关App实例所属的地域ID。
SmartAGId String 是 sag-kzo5dvms3dqii3*****

智能接入网关App实例ID。
UserName String 否 username

客户端的用户名。
PageNumber Integer 否 1

查询页码。默认值：1。

PageSize Integer 否 10

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

UserMail String 否 username@example.com

客户端的邮箱地址。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

列表条目数。
PageSize Integer 10

分页查询时每页的条目数。
RequestId String 62F4CF10-F909-487E-8E95-BC35457C5F50

请求ID。
PageNumber Integer 1

查询页码。
Users Array of User

客户端账号信息列表。
User
Bandwidth Integer 2000

客户端可使用的上云带宽。单位：Kbps。
State Integer 1

客户端的启用状态：

  • 0：表示启用该客户端。
  • 1：表示禁用该客户端。
ClientIp String 10.10.10.1

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

客户端的用户名。
UserMail String username@example.com

客户端的邮箱地址。
AccelerateBandwidth Long 1000

客户端可使用的应用加速带宽峰值。单位：Kbps。
IsStaticIp Long 0

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

  • 1：是。
  • 0：否。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSmartAccessGatewayClientUsers
&RegionId=cn-shanghai
&SmartAGId=sag-kzo5dvms3dqii3*****
&UserName=username
&PageNumber=1
&PageSize=10
&UserMail=username@example.com
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSmartAccessGatewayClientUsersResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>62F4CF10-F909-487E-8E95-BC35457C5F50</RequestId>
    <PageNumber>1</PageNumber>
    <Users>
        <Bandwidth>2000</Bandwidth>
        <State>1</State>
        <ClientIp>10.10.10.1</ClientIp>
        <UserName>username</UserName>
        <UserMail>username@example.com</UserMail>
        <AccelerateBandwidth>1000</AccelerateBandwidth>
        <IsStaticIp>0</IsStaticIp>
    </Users>
</DescribeSmartAccessGatewayClientUsersResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 SAG.InstanceIdEmpty You must specify the SAG instance ID. 智能接入网关实例ID为空。
400 SAG.InstanceNoFound The specified SAG instance does not exist. 智能接入网关实例不存在。

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