Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>

2023-10-11 08:28:11 +00:00

15 KiB

Raw Permalink Blame History

Querying SSH Key Pairs (Native OpenStack API)

Function

This interface is used to query SSH key pairs and to display the query results in a list.

Constraints

Pagination query is not supported.

URI

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

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For how to obtain the project ID, see Obtaining Required Information.

Request

Request parameters
None

Example request

1
GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs

Response

Response parameters

Parameter	Type	Description
keypairs	Array of objects	Specifies key pairs. For details, see Table 2.

**Table 2** **keypairs** field data structure description
Parameter	Type	Description
keypair	Object	Specifies details about a key pair. For details, see Table 3.

**Table 3** **keypair** field data structure description
Parameter	Type	Description
fingerprint	String	Specifies fingerprint information about the key pair.
name	String	Specifies the key pair name.
type	String	Specifies the key type, which is ssh by default. This field is supported in microversions later than 2.2.
public_key	String	Specifies information about the public key in the key pair.

Example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "keypairs": [
        {
            "keypair": {
                "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
                "name": "keypair-test",
                "type": "ssh",
                "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova"
            }
        }
    ]
}

Returned Values

Normal values

Returned Values	Description
200	The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS SSH Key Pair Management

15 KiB Raw Permalink Blame History