All Products
Search

This Product

    Bastionhost:ListHostShareKeys

    Document Center

    Bastionhost:ListHostShareKeys

    Last Updated:Jan 12, 2023

    Queries the shared keys that are associated with a host.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    yundun-bastionhost:ListHostShareKeys List
      All resources
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    InstanceId string Yes

    The ID of the bastion host. You can call the DescribeInstances operation to query the ID of the bastion host.

    		 bastionhost-cn-st220aw****
    RegionId string No

    The region ID of the bastion host. For more information about the mapping between region IDs and region names, see Regions and zones.

    		 cn-hangzhou
    PageNumber string No

    The number of the page to return. Default value: 1.

    		 1
    PageSize string No

    The number of entries to return on each page. Default value: 20.

    		 20

    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
    TotalCount long

    The total number of the shared keys.

    		 10
    HostShareKeys array

    An array that consists of the shared keys.
    object
    HostAccountCount long

    The number of the associated host accounts.

    		 1
    LastModifyKeyAt long

    The time when the shared key was last modified.

    		 1644806406
    HostShareKeyName string

    The name of the shared key.

    		 name
    PrivateKeyFingerPrint string

    The fingerprint of the private key.

    		 ****
    HostShareKeyId string

    The ID of the host account.

    		 10247

    Example

    Normal return example

    JSONFormat

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 10,
  "HostShareKeys": [
    {
      "HostAccountCount": 1,
      "LastModifyKeyAt": 1644806406,
      "HostShareKeyName": "name",
      "PrivateKeyFingerPrint": "****",
      "HostShareKeyId": "10247"
    }
  ]
}

    Error codes

    Http code Error code Error message
    400 InvalidParameter The argument is invalid.
    500 InternalError An unknown error occurred.

    For a list of error codes, visit the API error center.