DescribeKeyPairs
処理概要
指定した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」
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
KeyName.n | string |
SSHキー名 Default: 取得可能なすべてのSSHキー |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DescribeKeyPairsResponse | - |
DescribeKeyPairsレスポンス Ancestor: なし Children: requestId | keySet |
requestId | string |
リクエスト識別子 Ancestor: DescribeKeyPairsResponse Children: なし |
keySet | - |
取得したSSHキーの情報セット Ancestor: DescribeKeyPairsResponse Children: item |
item | - |
取得したSSHキーの情報 Ancestor: keySet Children: keyName | keyFingerprint | description | instancesSet |
keyName | string |
SSHキー名 Ancestor: item Children: なし |
keyFingerprint | string |
MD5 エンコードキー Ancestor: item Children: なし |
description | string |
SSHキーのメモ情報 Ancestor: item Children: なし |
instancesSet | - |
取得したサーバーの情報セット Ancestor: item Children: item |
item | - |
取得したサーバーの情報 Ancestor: instancesSet Children: instanceId | regionName |
instanceId | string |
サーバー名 Ancestor: item Children: なし |
regionName | string |
リージョン名 Ancestor: item Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?
Action=DescribeKeyPairs
&KeyName.1=sshkey01
&CommonParams
応答サンプル
<DescribeKeyPairsResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>cec1c6a8-9642-413c-a741-2f56e9138b64</requestId>
<keySet>
<item>
<keyName>sshkey01</keyName>
<keyFingerprint>4d:e4:...4c:64</keyFingerprint>
<description>KeyPairMemo</description>
<instancesSet>
<item>
<instanceId>server001</instanceId>
<regionName>east-1</regionName>
</item>
</instancesSet>
</item>
</keySet>
</DescribeKeyPairsResponse>