Queries the list of users of a Smart Access Gateway (SAG) APP instance.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
RegionId String Yes cn-shanghai

The ID of the region to which the SAG APP instance belongs.

SmartAGId String Yes sag-jfkskjfjf********

The ID of the SAG APP instance.

Action String No DescribeSmartAccessGatewayClientUsers

The name of this action.

Value: DescribeSmartAccessGatewayClientUsers

PageNumber Integer No 2

The page number in a paged query.

PageSize Integer No 21

The number of entries per page. Maximum value: 100

Default value: 50

UserName String No doctest

The username. Usernames associated with the same SAG APP instance must be unique.

The username and password are mutually dependent. If one is specified, the other must also be specified.

Response parameters

Parameter Type Example value Description
PageNumber Integer 1

The page number in a paged query.

PageSize Integer 12

The number of entries per page. Maximum value: 100

Default value:50

RequestId String 62F4CF10-F909-487E-8E95-BC35457C5F50

 The ID of the request.

TotalCount Integer 2

The number of users.

Users

The list of client users of an SAG APP instance.

Bandwidth Integer 2

The bandwidth.

ClientIp String 10.**. **. **

The IP address of the APP client.

State Integer 0

The status of the SAG APP.

UserMail String test@example.com

The email address of a common user.

UserName String doctest

The name of the user.

Examples

Request example


http(s)://[Endpoint]/? Action=DescribeSmartAccessGatewayClientUsers
&RegionId=cn-shanghai
&SmartAGId=sag-jfkskjfjf********
&<CommonParameters>

Response example

XML format

<DescribeSmartAccessGatewayClientUsersResponse>
  <Users>
    <User>
      <SmartAccessGatewayId>sag-va03wf***idaj00g6x</SmartAccessGatewayId>
      <IsStaticIp>0</IsStaticIp>
      <UserMail>dd@example.com</UserMail>
      <UserName>dd@example.com</UserName>
      <Bandwidth>2</Bandwidth>
    </User>
  </Users>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>62F4CF10-F909-487E-8E95-BC35457C5F50</RequestId>
  <PageNo>1</PageNo>
</DescribeSmartAccessGatewayClientUsersResponse>

JSON format

{
	"Users":{
		"User":[
			{
				"SmartAccessGatewayId":"sag-va03****idaj00g6x",
				"IsStaticIp":0,
				"UserMail":"dd@example.com",
				"UserName":"dd@example.com",
				"Bandwidth":2
			}
		]
	},
	"TotalCount":1,
	"PageSize":10,
	"PageNo":1,
	"RequestId":"62F4CF10-F909-487E-8E95-BC35457C5F50"
}

Errors

HTTP status code Error code Error message Description
400 SAG.InstanceIdEmpty You must specify the SAG instance ID. The ID of the SAG instance is empty.
400 SAG.InstanceNoFound The specified SAG instance does not exist. The specified SAG instance does not exist.

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