NiftyModifyRouterAttribute
処理概要
指定したルーターの詳細情報を更新します。1回のリクエストで、1つのルーターサーバーの情報を更新できます。ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーター名もしくはルータータイプを更新時、ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| RouterId | ルーターユニークID Type : String |
○ (ルーター名といずれか) |
|
| RouterName | ルーター名 Type : String |
○ (ルーターユニークIDといずれか) |
|
| Attribute | 更新対象の項目名 Type : String 値:routerName（ルーター名を更新） | description（メモを更新） | accountingType（利用料金タイプを更新）| type（ルータータイプを更新）| groupId（ファイアウォールを更新） |
○ | |
| Value | 更新値 Type : String 値: [Attribute=description] 空の場合、空で上書き [Attribute=accountingType] 1 (月額課金) | 2 (従量課金) [Attribute=type] small | medium | large |
○ | |
| Agreement | version up実施したのち、バックアップ状態を解除する事項への同意 Type:bBoolean Default:false |
○ （バックアップを保持する場合のみ） |
応答フィールド
| フィールド（項目） | 説明 | サンプル値 |
|---|---|---|
| NiftyModifyRouterAttributeResponse | NiftyModifyRouterAttributeResponseレスポンス Type : NiftyModifyRouterAttributeResponseType Ancestor : なし Children : requestId, return |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyModifyRouterAttributeResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| return | 処理ステータス Type : xsd:boolean Ancestor : NiftyModifyRouterAttributeResponse Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyModifyRouterAttribute&RouterId=nrt-8db04f81&Attribute=description&Value=RouterMemoUpdate&CommonParams
応答サンプル
<NiftyModifyRouterAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyModifyRouterAttributeResponse>
