CreateHostShareKey - Bastionhost - Alibaba Cloud Documentation Center

Bastionhost provides the shared key feature. This feature allows you to manage the private key that is used to log on to a host in a bastion host. This way, you can associate the private key with multiple accounts of the host to make host account management more efficient.

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.

Debug

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:CreateHostShareKey		All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The bastion host ID. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostShareKeyName	string	Yes	The name of the shared key that you want to create. The name can be a maximum of 128 characters in length.	name
PrivateKey	string	Yes	The private key. The value is a Base64-encoded string. Note You can specify a Rivest-Shamir-Adleman (RSA) key that is generated by using the ssh-keygen command or a key that is generated by using the Ed25519 algorithm.	****
PassPhrase	string	No	The password of the private key. The value is a Base64-encoded string.	*****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostShareKeyId	long	The ID of the shared key.	10235

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostShareKeyId": 10235
}

Error codes

HTTP status code	Error code	Error message	Description
400	HostShareKeyAlreadyExists	The host share key already exists.	-
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.