All Products
Search
Document Center

Smart Access Gateway:DescribeSmartAccessGatewayClientUsers

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:DescribeSmartAccessGatewayClientUsersRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the SAG app instance is deployed.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG app instance.

sag-kzo5dvms3dqii3*****
UserNamestringNo

The username of the client account.

username
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
UserMailstringNo

The email address of the client account.

username@example.com

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

62F4CF10-F909-487E-8E95-BC35457C5F50
PageNumberinteger

The number of the returned page.

1
Usersobject []

The information about the client account.

Bandwidthinteger

The maximum bandwidth allocated to the client account. Unit: Kbit/s.

2000
Stateinteger

Indicates whether the client is enabled. Valid values:

  • 0: enabled
  • 1: disabled
1
ClientIpstring

The IP address assigned by the system to the client.

10.10.10.1
UserNamestring

The username of the client account.

username
UserMailstring

The email address of the client account.

username@example.com
AccelerateBandwidthlong

The maximum application acceleration bandwidth allocated to the client account. Unit: Kbit/s.

1000
IsStaticIplong

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 codeError codeError messageDescription
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.

For a list of error codes, visit the Service error codes.