Querying the SSH Key Pair List
Function
Querying the SSH Key Pair List
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/keypairs
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
String |
Number of records on each page. Default value: 50 |
|
marker |
No |
String |
Specifies the resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
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 |
|---|---|---|
|
keypairs |
Array of Keypairs objects |
SSH key pair list |
|
page_info |
PageInfo object |
Pagination information. |
|
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. 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 |
|
frozen_state |
String |
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 |
|
Parameter |
Type |
Description |
|---|---|---|
|
next_marker |
String |
Query Address for Returning to the Next Page |
|
previous_marker |
String |
Return to the query address of the previous page. |
|
current_count |
Integer |
Number of returned items. |
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.
{
"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
}
} ],
"page_info" : {
"next_marker" : "KeyPair-dxxx",
"previous_marker" : "KeyPair-xxxx",
"current_count" : 49
}
}
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.
