Query SSH key pair details
Function
This API is used to query SSH key pair details.
URI
GET /v3/{project_id}/keypairs/{keypair_name}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
keypair_name |
Yes |
String |
Key pair name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
keypair |
KeypairDetail object |
Key pair details. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
SSH key pair name. |
id |
Integer |
SSH key pair ID. |
type |
String |
SSH key pair type. |
scope |
String |
Tenant-level or user-level. |
public_key |
String |
Public key information about an SSH key pair. |
fingerprint |
String |
Fingerprint information about an SSH key pair. |
is_key_protection |
Boolean |
Whether to host keys. |
deleted |
Boolean |
Tag that indicates an SSH key pair is deleted. |
description |
String |
Description of an SSH key pair. |
user_id |
String |
User that an SSH key pair belongs to. |
create_time |
Integer |
Time when the SSH key pair was created. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970). |
delete_time |
Integer |
Time when the SSH key pair was deleted. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970). |
update_time |
Integer |
Time when the SSH key pair was updated. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970). |
frozen_state |
Integer |
Frozen state. It can be:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
OK.
{ "keypair" : { "name" : "1hprr3TI", "id" : 116248, "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAGenerated-by-Nova\n", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "deleted" : false, "description" : "12345", "user_id" : "6c2a33b1b8474d0dbac0a24297127525", "create_time" : 1581507580000, "delete_time" : null, "update_time" : null, "frozen_state" : 0 } }
Status code: 400
Error occurred.
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK. |
400 |
Error occurred. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot