本文へジャンプします。

ニフクラ APIリファレンス

NiftyModifyCustomerGatewayAttribute

処理概要

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
CustomerGatewayId カスタマーゲートウェイユニークID
Type : String

(カスタマーゲートウェイ名といずれか)
 
NiftyCustomerGatewayName カスタマーゲートウェイ名
Type : String

(カスタマーゲートウェイユニークIDといずれか)
 
Attribute 更新対象の項目名
Type : String
値: niftyCustomerGatewayName(カスタマーゲートウェイ名を更新) | niftyCustomerGatewayDescription(カスタマーゲートウェイのメモ)
 
Value 更新値(空指定の場合、空で上書き)
Type : String
 

応答フィールド

フィールド 説明 サンプル値
NiftyModifyCustomerGatewayAttributeResponse NiftyModifyCustomerGatewayAttributeレスポンス
Type : NiftyModifyCustomerGatewayAttributeResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyModifyCustomerGatewayAttributeResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 更新ステータス
Type : xsd:boolean
Ancestor : NiftyModifyCustomerGatewayAttributeResponse
Children : なし
 

リクエストサンプル

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

応答サンプル

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

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

APIメニュー

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

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