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.
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 Resourcesis 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:CreateUserPublicKey | create | *All Resources * |
| 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. | Public key of a user |
| 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 parameters
Examples
Sample success responses
JSONformat
{
"PublicKeyId": "1",
"RequestId": "5EAB922E-F476-5DFA-9290-313C608E724B"
}Error codes
For a list of error codes, visit the Service error codes.