本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/DescribeKeyPairs.htmへ移行しました。 今後は新ページをご参照ください。

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レスポンス
requestId string リクエスト識別子
keySet - 取得したSSHキーの情報セット
item - 取得したSSHキーの情報
keyName string SSHキー名
keyFingerprint string MD5 エンコードキー
description string SSHキーのメモ情報
instancesSet - 取得したサーバーの情報セット
item - 取得したサーバーの情報
instanceId string サーバー名
regionName string リージョン名

リクエストサンプル

    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>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ 1024×768 以上