ListUserPublicKeys - Bastionhost - Alibaba Cloud Documentation Center

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:ListUserPublicKeys

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance where the user whose public keys you want to query resides. Note You can call the describeinstances operation to obtain this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance where the user resides. Note For the mapping between region IDs and region names, see Regions and zones.	cn-shanghai
PageNumber	string	No	The page number of the paged query. Default value: 1.	1
PageSize	string	No	The maximum number of entries to return on each page for a paged query. The maximum value of the PageSize parameter is 100. Default value: 20. If this parameter is empty, 20 entries are returned by default. Note We recommend that you do not leave the PageSize parameter empty.	50
UserId	string	No	The ID of the user whose public keys you want to query.	2

Response elements

Element	Type	Description	Example
	object	The response data.
PublicKeys	array<object>	The list of public keys of the user.
	object	The list of public keys of the user.
FingerPrint	string	The fingerprint of the public key.	d8:7d:b6:27:70:2d:07:fb:c6:b6:66:0a:86:7b:0f:9a
PublicKeyId	string	The ID of the public key.	1
PublicKeyName	string	The name of the public key.	Keyname
UserId	string	The ID of the user to whom the public key belongs.	1
Comment	string	The comment on the public key.	comment
RequestId	string	The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCount	integer	The total number of public keys.	5

Examples

Success response

JSON format

{
  "PublicKeys": [
    {
      "FingerPrint": "d8:7d:b6:27:70:2d:07:fb:c6:b6:66:0a:86:7b:0f:9a",
      "PublicKeyId": "1",
      "PublicKeyName": "Keyname",
      "UserId": "1",
      "Comment": "comment"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 5
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.