本文へジャンプします。

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

NiftyModifyKeyPairAttribute

処理概要

指定したSSHキーの情報を更新します。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
KeyName SSHキー名
Type : String
sshkey01
Attribute 更新対象の項目名
Type: String
値: description(メモ情報を更新)
 
Value 更新値
Type: String
値: [Attribute=description] 空の場合、空で上書き
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyModifyKeyPairAttributeResponse NiftyModifyKeyPairAttributeレスポンス
Type : NiftyModifyKeyPairAttributeResponseType
Ancestor : なし
Children : requestId, return, attribute, value
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyModifyKeyPairAttributeResponse
Children : なし
cec1c6a8-9642-413c-a741-2f56e9138b64
return 処理ステータス
Type: xsd:xs:boolean
Ancestor: NiftyModifyKeyPairAttributeResponse
Children: なし
 
attribute 更新対象の項目名
Type: xsd:string
Ancestor: NiftyModifyKeyPairAttributeResponse
Children: なし
 
value 更新値
Type: xsd:string
Ancestor: NiftyModifyKeyPairAttributeResponse
Children: なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyModifyKeyPairAttribute&KeyName=gsg-keypair&Attribute=description&Value=SSHmemoUpdate&CommonParams

応答サンプル

<NiftyModifyKeyPairAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <return>true</return>
  <attribute>description</attribute>
  <value>SSHmemoUpdate</value>
</NiftyModifyKeyPairAttributeResponse>

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

APIメニュー

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

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