ニフクラAPI (コンピューティング: NiftyModifyCustomerGatewayAttribute)

NiftyModifyCustomerGatewayAttribute

処理概要

指定されたカスタマーゲートウェイの詳細情報を更新します。1回のリクエストで1つのカスタマーゲートウェイの情報を更新できます。
カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。
メモの変更において、更新値に何も指定しない場合、空の情報で更新されます。

指定するパラメーター

パラメーター	型	説明	必須
CustomerGatewayId	string	カスタマーゲートウェイユニークID	○ (カスタマーゲートウェイ名といずれか)
NiftyCustomerGatewayName	string	カスタマーゲートウェイ名	○ (カスタマーゲートウェイユニークIDといずれか)
Attribute	string	更新対象の項目名 値: niftyCustomerGatewayName (カスタマーゲートウェイ名を更新) niftyCustomerGatewayDescription (カスタマーゲートウェイのメモ)	○
Value	string	更新値（空指定の場合、空で上書き）	○

応答フィールド

フィールド (項目)	型	説明
NiftyModifyCustomerGatewayAttributeResponse	-	NiftyModifyCustomerGatewayAttributeレスポンス
␣requestId	string	リクエスト識別子
␣return	boolean	更新ステータス 値: true (成功)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyModifyCustomerGatewayAttribute&CustomerGatewayId=cgw-8db04f81&Attribute=niftyCustomerGatewayDescription&Value=CustomermemoUpdate
  &CommonParams

  

応答サンプル

    <NiftyModifyCustomerGatewayAttributeResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyModifyCustomerGatewayAttributeResponse>