All Products
Search
Document Center

Bastionhost:GetHostShareKey

Last Updated:Sep 19, 2024

Queries the information about a shared key.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:GetHostShareKeyget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The bastion host ID.

Note You can call the DescribeInstances operation to query the bastion host ID.
bastionhost-cn-st220aw****
RegionIdstringNo

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
HostShareKeyIdstringYes

The ID of the shared key whose information you want to query.

Note You can call the ListHostShareKeys operation to query the shared key ID.
10427

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostShareKeyobject

The returned information about the shared key.

HostShareKeyIdstring

The ID of the shared key.

10427
HostShareKeyNamestring

The name of the shared key.

name
LastModifyKeyAtlong

The time when the information about the shared key was last modified. The value is a UNIX timestamp. Unit: seconds.

1644287246
PrivateKeyFingerPrintstring

The fingerprint of the private key.

***

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostShareKey": {
    "HostShareKeyId": "10427",
    "HostShareKeyName": "name",
    "LastModifyKeyAt": 1644287246,
    "PrivateKeyFingerPrint": "***"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
404HostShareKeyNotFoundThe host share key is not found.-
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.