• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. OpenStack Nova APIs
  5. SSH Key Management
  6. Querying a Specified SSH Key Pair

Querying a Specified SSH Key Pair

Function Description

This interface is used to query a specified SSH key pair based on the SSH key pair name.

URI

GET /v2/{project_id}/os-keypairs/{keypair_name}

GET /v2.1/{project_id}/os-keypairs/{keypair_name}

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

keypair_name

Yes

Specifies the key pair name.

Request

N/A

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

keypair

Dictionary data structure

Specifies the SSH key pair. For details, see Table 3.

Table 3 keypair field description

Parameter

Type

Description

public_key

String

Specifies information about the public key.

name

String

Specifies the key pair name.

fingerprint

String

Specifies fingerprint information about the key pair.

created_at

String:DateTime

Specifies the time when the key pair was created.

deleted

Boolean

Specifies whether a key pair has been deleted.

  • true: indicates that the key has been deleted.
  • false: indicates that the key is not deleted.

deleted_at

String:DateTime

Specifies the time when the key pair was deleted.

id

String

Specifies the key pair ID.

updated_at

String:DateTime

Specifies the time when the key pair was updated.

user_id

String

Specifies information about the user to which the key pair belongs.

Examples

  • Example response
    {
        "keypair": {
            "created_at": "2014-05-07T12:06:13.681238",
            "deleted": false,
            "deleted_at": null,
            "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01",
            "id": 1,
            "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314",
            "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova\n",
            "updated_at": null,
            "user_id": "fake"
        }
    }

Returned Values

See General Request Returned Values.