computing / Client / associate_address

associate_address

computing.Client.associate_address(**kwargs)

指定したサーバーへ付替IPアドレスを追加します。

元々サーバーに割り当てられていたIPアドレスは、付替IPアドレス設定中は確保された状態となり、付替IPアドレス解除時に再設定されます。

また付替IPアドレスの反映には、サーバーの再起動が必要になります。

再起動オプションをfalseで指定する場合はサーバー停止時のみ選択可能です。

付替IPアドレスをサーバーへ追加するには、サーバーの再起動もあり時間がかかることがあります。

サーバーのステータスは、API「DescribeInstances」のレスポンス値「instanceState」で確認できます。

また、付替IPアドレスが正しくサーバーに反映されているかの確認が必要です。

同じくAPI「DescribeInstances」のレスポンス値「ipType」もしくはAPI「DescribeAddresses」のレスポンス値「instanceId」で確認できます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.associate_address(
    AllocationId='string',
    AllowReassociation=True|False,
    InstanceId='string',
    NetworkInterfaceId='string',
    NiftyReboot='force'|'true'|'false',
    PrivateIpAddress='string',
    PublicIp='string'
)

Parameters:

• AllocationId (string) –

• AllowReassociation (boolean) –

• InstanceId (string) – [REQUIRED]

• NetworkInterfaceId (string) –

• NiftyReboot (string) –

• PrivateIpAddress (string) –

• PublicIp (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • RequestId (string) –

  • Return (boolean) –