List Keypairs

キーペアを一覧表示します。

APIエンドポイント

リージョン	APIエンドポイント
西日本リージョン3の場合	https://compute.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://compute.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI

GET

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

HTTPステータスコード

正常時：200

エラー時：401, 403

リクエストパラメータの説明

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
user_id	query	string	任意	結果をユーザーIDで絞り込みます。 📒注: マイクロバージョン2.10以上を指定してください。
limit	query	integer	任意	クエリ結果で返却される項目の最大数 指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。 📒注: マイクロバージョン2.35以上を指定してください。
marker	query	string	任意	前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。 📒注: マイクロバージョン2.35以上を指定してください。

レスポンスボディ（正常系）の説明

名前	Type	Description
keypairs	array	キーペアオブジェクトのリスト
keypair	object	キーペアオブジェクト
name	string	キーペア名
public_key	string	公開キー
fingerprint	string	フィンガープリント
type	string	キーペアのタイプ 「ssh」または「x509」を指定します。 📒注: 表示するにはマイクロバージョン2.2以上を指定してください。
keypairs_links	array	キーペアのリンクURL 📒注: 表示するにはマイクロバージョン2.35以上を指定してください。

レスポンス例

{
    "keypairs": [
        {
            "keypair": {
                "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
                "name": "keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3",
                "type": "ssh",
                "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCkF3MX59OrlBs3dH5CU7lNmvpbrgZxSpyGjlnE8Flkirnc/Up22lpjznoxqeoTAwTW034k7Dz6aYIrZGmQwe2TkE084yqvlj45Dkyoj95fW/sZacm0cZNuL69EObEGHdprfGJQajrpz22NQoCD8TFB8Wv+8om9NH9Le6s+WPe98WC77KLw8qgfQsbIey+JawPWl4O67ZdL5xrypuRjfIPWjgy/VH85IXg/Z/GONZ2nxHgSShMkwqSFECAC5L3PHB+0+/12M/iikdatFSVGjpuHvkLOs3oe7m6HlOfluSJ85BzLWBbvva93qkGmLg4ZAc8rPh2O+YIsBUHNLLMM/oQp Generated-by-Nova\n"
            }
        }
    ],
    "keypairs_links": [
        {
            "href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/keypairs?limit=1&marker=keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3",
            "rel": "next"
        }
    ]
}