ListUsers - Bastionhost - Alibaba Cloud Documentation Center

Queries the users of a specified Bastionhost 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.

debugging

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:ListUsers	List	All Resources	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance to which the users to be queried belong. Note You can call the DescribeInstances operation to query the ID of the Bastionhost instance.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance to which the users to be queried belong. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. The value of the PageSize parameter must not exceed 100. By default, the number of entries on each page is 20. If you do not set the PageSize parameter, 20 entries are returned per page by default. Note We recommend that you do not leave this parameter empty.	20
UserName	string	No	The logon name of the user to be queried. Only exact match is supported.	abc
DisplayName	string	No	The display name of the user to be queried. Only exact match is supported.	abc
Source	string	No	The source of the user to be queried. Valid values: Local: a local user Ram: a RAM user	Local
Mobile	string	No	The mobile number of the user to be queried. Only exact match is supported.	1359999****
UserState	string	No	The status of the user to be queried. Valid values: Normal: The user can access the Bastionhost instance. Frozen: The user is locked and cannot access the Bastionhost instance. Expired: The user has expired and cannot access the Bastionhost instance.	Normal
SourceUserId	string	No	The unique ID of the user to be queried. Only exact match is supported. Note This parameter uniquely identifies a RAM user of the Bastionhost instance. This parameter takes effect only when the Source parameter is set to Ram. You can call the ListUsers operation to obtain the unique ID of the user from the UserId response parameter.	122748924538****
UserGroupId	string	No	The ID of the user group to be queried. Note You can call the ListUserGroups operation to query the ID of the user group.	1

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of users that were queried.	1
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Users	object []	The list of users that were queried.
DisplayName	string	The display name of the user.	Bob
Email	string	The email address of the user.	1099**@qq.com
Comment	string	The description of the user.	comment
MobileCountryCode	string	The country where the mobile number of the user is registered. Valid values: CN: the Chinese mainland, whose country calling code is +86 HK: Hong Kong (China), whose country calling code is +852 MO: Macau (China), whose country calling code is +853 TW: Taiwan (China), whose country calling code is +886 RU: Russia, whose country calling code is +7 SG: Singapore, whose country calling code is +65 MY: Malaysia, whose country calling code is +60 ID: Indonesia, whose country calling code is +62 DE: Germany, whose country calling code is +49 AU: Australia, whose country calling code is +61 US: United States, whose country calling code is +1 AE: United Arab Emirates, whose country calling code is +971 JP: Japan, whose country calling code is +81 GB: United Kingdom, whose country calling code is +44 IN: India, whose country calling code is +91 KR: South Korea, whose country calling code is +82 PH: Philippines, whose country calling code is +63 CH: Switzerland, whose country calling code is +41 SE: Sweden, whose country calling code is +46	CN
Mobile	string	The mobile number of the user.	1359999****
UserId	string	The ID of the user.	1
Source	string	The source of the user. Valid values: Local: a local user Ram: a RAM user	Local
UserName	string	The logon name of the user.	abc_def
SourceUserId	string	The unique ID of the user. Note This parameter uniquely identifies a RAM user of the Bastionhost instance. A value is returned for this parameter if the Source parameter is set to Ram. No value is returned for this parameter if the Source parameter is set to Local.	122748924538****
UserState	array	The statuses of the user.
	string	The status of the user. Valid values: Normal: The user can access the Bastionhost instance. Frozen: The user is locked and cannot access the Bastionhost instance. Expired: The user has expired and cannot access the Bastionhost instance.	["Normal"]
EffectiveStartTime	long	The beginning of the validity period of the user. The value is a UNIX timestamp. Unit: seconds.	1669630029
EffectiveEndTime	long	The end of the validity period of the user. The value is a UNIX timestamp. Unit: seconds.	1672502400
NeedResetPassword	boolean	Specifies whether password reset is required upon the next logon. Valid values: true: yes false: no	true
TwoFactorStatus	string	The two-factor authentication status of the user. Valid values: Global: follows the global settings Disable: disables two-factor authentication Enable: enable two-factor authentication and follows settings of the single user	Enable
TwoFactorMethods	array	The two-factor authentication method.
	string	The two-factor authentication method. You can select only one method. Valid values: sms: text message email: email dingtalk: DingTalk totp OTP: time-based one-time password (TOTP) app Note When the TwoFactorStatus parameter is set to Enable, you must specify one of the preceding values.	[ "sms" ]

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Users": [
    {
      "DisplayName": "Bob",
      "Email": "1099**@qq.com",
      "Comment": "comment",
      "MobileCountryCode": "CN",
      "Mobile": "1359999****",
      "UserId": "1",
      "Source": "Local",
      "UserName": "abc_def",
      "SourceUserId": "122748924538****",
      "UserState": [
        "[\"Normal\"]"
      ],
      "EffectiveStartTime": 1669630029,
      "EffectiveEndTime": 1672502400,
      "NeedResetPassword": true,
      "TwoFactorStatus": "Enable",
      "TwoFactorMethods": [
        "[\n      \"sms\"\n]"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.

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