本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeKeyPairs

処理概要

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

SSHキーを指定するためには、SSHキー名が必要です。SSHキーを指定しない場合は、取得できるすべてのSSHキー情報を取得します。削除済みのSSHキーを指定した、管理外のSSHキーを指定したなど、無効なSSHキーを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
KeyName.n SSHキー名
Type : String
Default : 取得可能なすべてのSSHキー
  sshkey01

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeKeyPairsResponse DescribeKeyPairsレスポンス
Type : DescribeKeyPairsResponseType
Ancestor : なし
Children : requestId, keySet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeKeyPairsResponse
Children : なし
cec1c6a8-9642-413c-a741-2f56e9138b64
keySet 取得したSSHキーの情報セット
Type : DescribeKeyPairsResponseInfoType
Ancestor : DescribeKeyPairsResponse
Children : item
 
item 取得したSSHキーの情報
Type : DescribeKeyPairsResponseItemType
Ancestor : keySet
Children : keyName, keyFingerprint
 
keyName SSHキー名
Type : xsd:string
Ancestor : item
Children : なし
sshkey01
keyFingerprint SHA-1エンコードキー
Type : xsd:string
Ancestor : item
Children : なし
[B@17a3d13
description SSHキーのメモ情報
Type : xsd:string
Ancestor : item
Children : なし
 
instancesSet 取得したサーバーの情報セット
Type : instancesSet
Ancestor : item
Children : item
 
item 取得したサーバーの情報
Type : instances
Ancestor : item
Children : item
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
 
regionName リージョン名
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeKeyPairs&KeyName.1=sshkey01&CommonParams

応答サンプル

<DescribeKeyPairsResponse xmlns="https://cp.cloud.nifty.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メニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

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