You can call this operation to query client accounts added to a Smart Access Gateway (SAG) APP instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeSmartAccessGatewayClientUsers |
The operation that you want to perform. Set the value to DescribeSmartAccessGatewayClientUsers. |
RegionId | String | Yes | cn-shanghai |
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 account. Usernames of client accounts added to the same SAG APP instance must be unique. |
PageNumber | Integer | No | 2 |
The number of the page to return. |
PageSize | Integer | No | 21 |
The number of entries to return on each page. Maximum value: 100. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 62F4CF10-F909-487E-8E95-BC35457C5F50 |
The ID of the request. |
TotalCount | Integer | 2 |
The number of client accounts added to the SAG APP instance. |
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 12 |
The number of entries returned per page. Maximum value: 100. Default value: 10. |
Users | Array |
The user information about SAG APP. |
|
ClientIp | String | 10.**. **. ** |
The IP address of SAG APP. |
UserMail | String | test@example.com |
The email address of the user. |
UserName | String | doctest |
The username of the client account. |
Bandwidth | Integer | 2 |
The bandwidth specified for SAG APP. |
State | Integer | 0 |
The status of the client account. Valid values:
|
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeSmartAccessGatewayClientUsers
&RegionId=cn-shanghai
&SmartAGId=sag-jfkskjfjf********
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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"
}
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 specified. |
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.