AllocateAddress
処理概要
付替IPアドレスを割り当てます。1回のリクエストで、１つのグローバルIPアドレスまたはプライベートIPアドレスが割り当てられます。
割り当てられるIPアドレスは、ニフクラにより決定されます。
処理が失敗した場合、IPアドレスは割り当てされず、エラーが返されます。
サーバーを指定した場合、共通グローバル/共通プライベートの固定IPアドレスが付替IPアドレスに変更されます。
サーバーを指定するためには、サーバー名が必要です。処理中のサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| Domain | ※指定不可 Type : String |
||
| NiftyPrivateIp | プライベートIP Type : boolean 値 : true （プライベートIP） | false （グローバルIP） Default : false |
||
| Placement.AvailabilityZone | ゾーン名 Type : String Default : ニフクラが決定 |
||
| InstanceId | サーバー名 Type :String |
応答フィールド
| フィールド | 説明 | サンプル値 |
|---|---|---|
| AllocateAddressResponse | AllocateAddressレスポンス Type : AllocateAddressResponseType Ancestor : なし Children : requestId, publicIp, privateIpAddress, domain, allocationId, placement |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : AllocateAddressResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| publicIp | 割り当てられたグローバルIPアドレス Type : xsd:string Ancestor : AllocateAddressResponse Children : なし |
|
| privateIpAddress | 割り当てられたプライベートIPアドレス Type : xsd:string Ancestor : AllocateAddressResponse Children : なし |
|
| domain | ※返却値なし Type : xsd:string Ancestor : AllocateAddressResponse Children : なし |
|
| allocationId | ※返却値なし Type : xsd:string Ancestor : AllocateAddressResponse Children : なし |
|
| placement | ゾーン情報 Type : PlacementResponseType Ancestor : AllocateAddressResponse Children : availabilityZone |
|
| availabilityZone | ゾーン名 Type : xsd:string Ancestor : placement Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=AllocateAddress&NiftyPrivateIp=false&Placement.AvailabilityZone=east-11&CommonParams 応答サンプル
<AllocateAddressResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<publicIp>172.16.2.1</publicIp>
<placement>
<availabilityZone>east-11</availabilityZone>
</placement>
</AllocateAddressResponse> 
