Querying SSH Key Pair Details
Function
Querying SSH Key Pair Details
Calling Method
For details, see Calling APIs.
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. Can be obtained by calling the IAM API for obtaining the user token (the 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 |
Long |
SSH key pair ID |
|
type |
String |
SSH key pair type. The value can be ssh or x509. |
|
scope |
String |
Tenant-level or user-level. The value can be domain or user. |
|
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 |
Long |
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 |
Long |
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 |
Long |
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 Status - 0: normal, not frozen - 1: frozen due to common causes - 2: frozen by the public security bureau - 3: frozen due to common causes and by the public security bureau - 4: frozen due to violations - 5: frozen due to common causes and violations - 6: frozen by the public security bureau and due to violations - 7: frozen by the public security bureau and due to common causes and violations - 8: frozen due to lack of real-name authentication - 9: frozen due to common causes and lack of real-name authentication - 10: frozen by the public security bureau and due to lack of real-name authentication |
|
key_id |
String |
Specifies the key pair ID. |
|
algorithm |
String |
Generation algorithm. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Codes |
|
error_msg |
String |
Description |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{
"keypair" : {
"name" : "1hprr3TI",
"id" : 116248,
"type" : "ssh",
"scope" : "user",
"public_key" : "ssh-rsa AAAGenerated-by-Nova",
"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 response
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
Error response |
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.
