nifty-modify-customer-gateway-attribute
処理概要
API「NiftyModifyCustomerGatewayAttribute」が実行されます。
指定されたカスタマーゲートウェイの詳細情報を更新します。1回のリクエストで1つのカスタマーゲートウェイの情報を更新できます。
カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。削除済みのカスタマーゲートウェイを指定した、管理外のカスタマーゲートウェイを指定したなど、無効なカスタマーゲートウェイを指定した場合は、エラーが返されます。
メモの変更において、更新値に何も指定しない場合、空の情報で更新されます。
コマンド構文
nifty-modify-customer-gateway-attribute [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --customer-gateway-id ID | -c | カスタマーゲートウェイユニークIDを指定します。 | ○ (カスタマーゲートウェイ名といずれか) |
| --customer-gateway-name NAME | -C | カスタマーゲートウェイ名を指定します。 | ○ (カスタマーゲートウェイユニークIDといずれか) |
| --customer-gateway-name-updateNAME | カスタマーゲートウェイ名を更新します。 | ||
| --customer-gateway-description DESCRIPTION | カスタマーゲートウェイのメモを更新します。 |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- customerGatewayId or niftyCustomerGatewayName
- 属性名（指定したパラメーターによって異なります）
- value
実行サンプル
PROMPT>nifty-modify-customer-gateway-attribute --customer-gateway-id cgw-8db04f81 --customer-gateway-description AppServer
cgw-8db04f81 customer Gateway Description AppServer
