本文へジャンプします。

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

CreateKeyPair

処理概要

SSHキーを新規作成します。

SSHキーには、SSHキー名およびパスワードを設定します。SSHキー名には、同じユーザーが作るキーのうち、一意となる文字列を指定します。設定したパスワードが使用可能文字ルールに適合しない場合は、エラーが返されます。

作成したSSHキーペアのフィンガープリントが一致しているかどうかの確認方法は、DescribeKeyPairsの処理概要をご確認ください。

指定するパラメーター

パラメーター 説明 必須 サンプル値
KeyName SSHキー名
Type : String
使用可能文字 : 半角英数字、空白、一部の記号 ' _
sshkey02
Password パスワード
Type : String
使用可能文字 : 半角英数字のみ
password
Description メモ
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
CreateKeyPairResponse CreateKeyPairレスポンス
Type : CreateKeyPairResponseType
Ancestor : なし
Children : requestId, keyName, keyFingerprint, keyMaterial
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CreateKeyPairResponse
Children : なし
cec1c6a8-9642-413c-a741-2f56e9138b64
keyName SSHキー名
Type : xsd:string
Ancestor : CreateKeyPairResponse
Children : なし
sshkey02
keyFingerprint MD5 エンコードキー
Type : xsd:string
Ancestor : CreateKeyPairResponse
Children : なし
6a:99:・・・88:91
keyMaterial Base64 エンコードされたRSAキー
Type : xsd:string
Ancestor : CreateKeyPairResponse
Children : なし
LS0tLS1CRUdJTiBSU0E
… ZLS0tLS0K
description メモ
Type: xsd:string
Ancestor: CreateKeyPairResponse
Children: なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CreateKeyPair&KeyName=sshkey02&Password=password&Description=Memo&CommonParams

応答サンプル

<CreateKeyPairResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>cec1c6a8-9642-413c-a741-2f56e9138b64</requestId>
  <keyName>sshkey02</keyName>
  <keyFingerprint>6a:99:・・・88:91<keyFingerprint>
  <keyMaterial> LS0tLS1CRUdJTiBSU0EgUFJJVkFU
  :(省略)
  ZLS0tLS0K </keyMaterial>
  <description>Memo</description>
</CreateKeyPairResponse>

ニフティクラウド サイト内検索

APIメニュー

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

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