本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/AssociateAddress.htmへ移行しました。 今後は新ページをご参照ください。

AssociateAddress

処理概要

指定したサーバーへ付替IPアドレスを追加します。
元々サーバーに割り当てられていたIPアドレスは、付替IPアドレス設定中は確保された状態となり、付替IPアドレス解除時に再設定されます。
また付替IPアドレスの反映には、サーバーの再起動が必要になります。
再起動オプションをfalseで指定する場合はサーバー停止時のみ選択可能です。

付替IPアドレスをサーバーへ追加するには、サーバーの再起動もあり時間がかかることがあります。
サーバーのステータスは、API「DescribeInstances」のレスポンス値「instanceState」で確認できます。
また、付替IPアドレスが正しくサーバーに反映されているかの確認が必要です。
同じくAPI「DescribeInstances」のレスポンス値「ipType」もしくはAPI「DescribeAddresses」のレスポンス値「instanceId」で確認できます。

指定するパラメーター

パラメーター 説明 必須
PublicIp string グローバルIPアドレス
○ (PrivateIpAddressといずれか)
PrivateIpAddress string プライベートIPアドレス
○ (PublicIpといずれか)
InstanceId string サーバー名
NiftyReboot string 再起動オプション
値:
  • force (強制再起動)
  • true (通常再起動)
  • false (再起動しない)
Default: true
AllocationId string ※指定不可
NetworkInterfaceId string ※指定不可
AllowReassociation boolean ※指定不可

応答フィールド

フィールド (項目) 説明
AssociateAddressResponse - AssociateAddressレスポンス
requestId string リクエスト識別子
return boolean 処理ステータス
値:
  • true (成功)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=AssociateAddress
  &PublicIp=172.16.2.1
  &InstanceId=server01
  &NiftyReboot=true
  &CommonParams

  

応答サンプル

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

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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