CreateUserPublicKey - Bastionhost - Alibaba Cloud Documentation Center

Creates a public key for a bastion host user and hosts the public key in the bastion host. This way, O\\\\\\&M engineers can use the private key that corresponds to the public key to log on to the bastion host from an O\\\\\\&M client.

Operation description

You can call the CreateUserPublicKey operation to create a public key for the specified user of a 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:CreateUserPublicKey

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Specifies the region ID of the bastion host on which you want to create a public key for the user. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
InstanceId	string	Yes	The ID of the bastion host on which you want to create a public key for the user. Note You can call the listinstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
UserId	string	Yes	The ID of the user for whom you want to create a public key. Note You can call the ListUsers operation to query the user ID.	1
PublicKeyName	string	Yes	The name of the public key.	KeyName
PublicKey	string	Yes	The public key. Encode the value by using the Base64 algorithm.	c3NoLWVkMjU1MTkgQUFBQUMzTnphQzFsWkRJMU5URTVBQUFBSUxGQnQxUUpyT3IxK2hTTGRkbERMZUx4WGRIZ3hBalBxWHJIbWNFNWxqSk8gbm93Y29kZXJAbm93Y29kZXJkZU1hY0Jvb2stUHJvLmxvY2Fs
Comment	string	No	The description of the public key. The description can be up to 500 characters in length.	comment

Response elements

Element	Type	Description	Example
	object	The data returned.
PublicKeyId	string	The ID of the public key.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	5EAB922E-F476-5DFA-9290-313C608E724B

Examples

Success response

JSON format

{
  "PublicKeyId": "1",
  "RequestId": "5EAB922E-F476-5DFA-9290-313C608E724B"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.