All Products
Search
Document Center

Bastionhost:ListUserPublicKeys

Last Updated:Apr 18, 2024

Queries all public keys of the specified user.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host on which you want to query all public keys of the user.

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

The region ID of the bastion host on which you want to query all public keys of the user.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-shanghai
PageNumberstringNo

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

1
PageSizestringNo

The number of entries to return on each page.
Maximum value: 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
50
UserIdstringNo

The ID of the user whose public keys you want to query.

2

Response parameters

ParameterTypeDescriptionExample
object

The response data.

PublicKeysobject []

An array that consists of the public keys of the user.

FingerPrintstring

The fingerprint of the public key.

d8:7d:b6:27:70:2d:07:fb:c6:b6:66:0a:86:7b:0f:9a
PublicKeyIdstring

The ID of the public key.

1
PublicKeyNamestring

The name of the public key.

Keyname
UserIdstring

The ID of the user to which the public key belongs.

1
Commentstring

The description of the public key.

comment
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

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

The total number of public keys.

5

Examples

Sample success responses

JSONformat

{
  "PublicKeys": [
    {
      "FingerPrint": "d8:7d:b6:27:70:2d:07:fb:c6:b6:66:0a:86:7b:0f:9a",
      "PublicKeyId": "1",
      "PublicKeyName": "Keyname",
      "UserId": "1",
      "Comment": "comment"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 5
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

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