DescribeSmartAccessGatewayClientUsers - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeSmartAccessGatewayClientUsers	The operation that you want to perform. Set the value to DescribeSmartAccessGatewayClientUsers.
RegionId	String	Yes	cn-shanghai	The ID of the region where the SAG APP instance is deployed.
SmartAGId	String	Yes	sag-jfkskjfjf********	The ID of the SAG app instance.
UserName	String	No	doctest	The username of the client.
PageNumber	Integer	No	1	The page number of the returned page. Default value: 1.
PageSize	Integer	No	10	The number of entries to return on each page. Default value: 10.
UserMail	String	No	123456@example.com	The email address of the client.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of entries returned.
PageSize	Integer	10	The number of entries to return on each page.
RequestId	String	62F4CF10-F909-487E-8E95-BC35457C5F50	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.
Users	Array of User		The information about the client account.
User
Bandwidth	Integer	2000	The bandwidth that can be used by the clients. Unit: Kbit/s.
State	Integer	1	Indicates whether the client is enabled. Valid values: 0: indicates that the client is enabled. 1: indicates that the client is disabled.
ClientIp	String	10.10.10.1	The IP address assigned by the system to the client.
UserName	String	doctest	The username of the client.
UserMail	String	123456@example.com	The email address of the client.
AccelerateBandwidth	Long	1000	The peak application acceleration bandwidth available to the client. Unit: Kbit/s.
IsStaticIp	Long	true	Indicates whether the client IP address is a static IP address. true false

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSmartAccessGatewayClientUsers
&RegionId=cn-shanghai
&SmartAGId=sag-jfkskjfjf********
&UserName=doctest
&PageNumber=1
&PageSize=10
&UserMail=123456@example.com
&<Common request parameters>

Sample success responses

XML format

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>doctest</UserName>
        <UserMail>123456@example.com</UserMail>
        <AccelerateBandwidth>1000</AccelerateBandwidth>
    </Users>
</DescribeSmartAccessGatewayClientUsersResponse>

JSON format

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" : "doctest",
    "UserMail" : "123456@example.com",
    "AccelerateBandwidth" : 1000
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	The error message returned because the ID of the SAG instance is not set.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The error message returned because the specified SAG instance does not exist.

For a list of error codes, visit the API Error Center.