本文へジャンプします。

ニフティクラウド APIリファレンス

AssociateAddress

処理概要

指定したサーバーへ付替IPアドレスを追加します。
サーバーを指定するためには、サーバー名が必要です。解放済みのサーバーを指定した、管理外のサーバーを指定した、起動中・停止中以外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。
また付替IPアドレスの反映には、サーバーの再起動が必要になります。
再起動しないを選択される場合は、設定完了後、120秒程度時間を空けてからIP再取得を実施してください。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
PublicIp グローバルIPアドレス
Type : String

(PrivateIpAddressといずれか)
 
PrivateIpAddress プライベートIPアドレス
Type : String

(PublicIpといずれか)
 
InstanceId サーバー名
Type : String
server02
NiftyReboot 再起動オプション
Type : String
値 : force(強制再起動) | true(通常再起動) | false(再起動しない)
Default : true
   
AllocationId ※指定不可
Type : String
   
NetworkInterfaceId ※指定不可
Type : String
   
AllowReassociation ※指定不可
Type : Boolean
   

応答フィールド

フィールド 説明 サンプル値
AssociateAddressResponse AssociateAddressレスポンス
Type : AssociateAddressResponseType
Ancestor : なし
Children : requestId, return, associationId
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : AssociateAddressResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
return 処理ステータス
Type : xsd: boolean
値 : true (成功)
Ancestor : AssociateAddressResponse
Children : なし
 
associationId ※返却値なし
Type : xsd:string
Ancestor : AssociateAddressResponse
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=AssociateAddress&PublicIp=172.16.2.1&InstanceId=server01&NiftyReboot=true&CommonParams

応答サンプル

<AssociateAddressResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>f6dd8353-eb6b-6b4fd32e4f06</requestId>
 <return>true</return>
</AssociateAddressResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

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