GetUser - Bastionhost - Alibaba Cloud Documentation Center

Queries the details of a user of the specified bastion host.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:GetUser

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host on which you want to query the user. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host on which you want to query the user. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserId	string	Yes	The ID of the user. Note You can call the ListUsers operation to query the ID of the user.	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 elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
User	object	The detailed information about the queried user.
DisplayName	string	The display name of the user.	Bob
Comment	string	The description of the user.	commet
Email	string	The email address of the user.	1099**@qq.com
Mobile	string	The mobile phone number of the user.	1359999****
MobileCountryCode	string	The location in which 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: Macao (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: US, 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: UK, whose country calling code is +44 IN: India, whose country calling code is +91 KR: Republic of 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
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.	abcabc_def
SourceUserId	string	The unique ID of the user. Note This parameter uniquely identifies a RAM user of the bastion host. 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	An array that consists of the details of the user status.
	string	The status of the user. Valid values: Normal: active Frozen: locked Expired: expired	["Normal"]
EffectiveStartTime	integer	The beginning of the validity period of the user. The value is a UNIX timestamp. Unit: seconds.	1669630029
EffectiveEndTime	integer	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
TwoFactorMethods	array	An array that consists of the details of 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	[ "sms" ]
TwoFactorStatus	string	The two-factor authentication status of the user. Valid values: Global: The global settings are used. Disable: The two-factor authentication is disabled. Enable: The two-factor authentication is enabled and the user-specific setting is used.	Enable
LanguageStatus	string	Indicates whether notifications are sent in the language specified in the global settings or a custom language. Global: Global Custom: Custom	Custom
Language	string	This parameter is required if LanguageStatus is set to Custom. zh-cn: simplified Chinese. en: English.	en

Examples

Success response

JSON format

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

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.
404	UserNotFound	The user is not found.	The user is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.