computing / Client / describe_key_pairs

describe_key_pairs

computing.Client.describe_key_pairs(**kwargs)

指定したSSHキーの情報を取得します。

SSHキーを指定するためには、SSHキー名が必要です。SSHキーを指定しない場合は、取得できるすべてのSSHキー情報を取得します。

キーペアのフィンガープリントが一致しているかどうかはレスポンス値「keyFingerprint」で確認できます。

秘密鍵に対し、以下のコマンドを実行した場合に取得するfingerprintの値とDescribeKeyPairsで返却されるKeyFingerprintの値が同一であれば、キーペアのフィンガープリントが一致していることが確認できます。

CreateKeyPairで作成した場合：

「openssl rsa -in 秘密鍵ファイル − pubout − outformDER − passinpass:{パスフレーズ} | openssl md5 -c」

ImportKeyPairを利用した際は、鍵形式にあわせて確認できます。

SSH-RSAの場合：「openssl rsa -in 秘密鍵ファイル − pubout − outformDER − passinpass:{パスフレーズ} | openssl md5 ?c」

SSH-DSAの場合：「openssl dsa -in 秘密鍵ファイル − pubout − outformDER − passinpass:{パスフレーズ} | openssl md5 ?c」

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_key_pairs(
    KeyName=[
        'string',
    ]
)

Parameters:

KeyName (list) –

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'KeySet': [
        {
            'Description': 'string',
            'InstancesSet': [
                {
                    'InstanceId': 'string',
                    'RegionName': 'string'
                },
            ],
            'KeyFingerprint': 'string',
            'KeyName': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • KeySet (list) –

    • (dict) –

      • Description (string) –

      • InstancesSet (list) –

        • (dict) –

          • InstanceId (string) –

          • RegionName (string) –

      • KeyFingerprint (string) –

      • KeyName (string) –

  • RequestId (string) –