computing / Client / nifty_modify_router_attribute

nifty_modify_router_attribute

computing.Client.nifty_modify_router_attribute(**kwargs)

指定したルーターの詳細情報を更新します。1回のリクエストで、1つのルーターサーバーの情報を更新できます。ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。

ルーター名もしくはルータータイプを更新時、ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_modify_router_attribute(
    Agreement=True|False,
    Attribute='routerName'|'description'|'accountingType'|'type'|'groupId',
    RouterId='string',
    RouterName='string',
    Value='string'
)

Parameters:

• Agreement (boolean) –

• Attribute (string) – [REQUIRED]

• RouterId (string) –

• RouterName (string) –

• Value (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

• (dict) –

  • RequestId (string) –

  • Return (boolean) –