クラウドAPI (コンピューティング: NiftyModifyKeyPairAttribute)

NiftyModifyKeyPairAttribute

処理概要

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

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

指定するパラメーター

パラメーター	型	説明	必須
KeyName	string	SSHキー名	○
Attribute	string	更新対象の項目名 値: description (メモ情報を更新)	○
Value	string	更新値	○

応答フィールド

フィールド (項目)	型	説明
NiftyModifyKeyPairAttributeResponse	NiftyModifyKeyPairAttributeResponseType	NiftyModifyKeyPairAttributeレスポンス Ancestor: なし Children: requestId | return | attribute | value
requestId	string	リクエスト識別子 Ancestor: NiftyModifyKeyPairAttributeResponse Children: なし
return	boolean	処理ステータス Ancestor: NiftyModifyKeyPairAttributeResponse Children: なし
attribute	string	更新対象の項目名 Ancestor: NiftyModifyKeyPairAttributeResponse Children: なし
value	string	更新値 Ancestor: NiftyModifyKeyPairAttributeResponse Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
  Action=NiftyModifyKeyPairAttribute
  &KeyName=gsg-keypair
  &Attribute=description
  &Value=SSHmemoUpdate
  &CommonParams

  

応答サンプル

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