DescribeSmartAccessGatewayClientUsers - Smart Access Gateway

Queries client accounts added to a Smart Access Gateway (SAG) app instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeSmartAccessGatewayClientUsers	get	*SmartAccessGateway `acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG app instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG app instance.	sag-kzo5dvms3dqii3*****
UserName	string	No	The username of the client account.	username
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
UserMail	string	No	The email address of the client account.	username@example.com

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	62F4CF10-F909-487E-8E95-BC35457C5F50
PageNumber	integer	The number of the returned page.	1
Users	array<object>	The information about the client account.
User	object
Bandwidth	integer	The maximum bandwidth allocated to the client account. Unit: Kbit/s.	2000
State	integer	Indicates whether the client is enabled. Valid values: 0: enabled 1: disabled	1
ClientIp	string	The IP address assigned by the system to the client.	10.10.10.1
UserName	string	The username of the client account.	username
UserMail	string	The email address of the client account.	username@example.com
AccelerateBandwidth	long	The maximum application acceleration bandwidth allocated to the client account. Unit: Kbit/s.	1000
IsStaticIp	long	Indicates whether the client IP address is a static IP address. 1: yes 0: no	0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
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 Service error codes.