Query the SSH key pair list
Function
This API is used to query the list of SSH key pairs.
URI
GET /v3/{project_id}/keypairs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
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 |
---|---|---|
keypairs |
Array of ListKeypairs objects |
SSH key pair list. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
SSH key pair name. |
type |
String |
Type of the SSH key pair. The value can be ssh or x509. |
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. |
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
Request processing succeeded.
{ "keypairs" : [ { "keypair" : { "name" : "1hprr3TI", "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABjV8GvwpSs.....", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "frozen_state" : 0 } } ] }
Status code: 400
Error occurred.
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request processing succeeded. |
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