処理概要
IPアドレスを取得
注意事項
・networkidはPublicFrontSegmentのidを指定してください。
リクエスト
・リクエストパラメータ
Parameter Name | Description | Required |
networkid | The network this IP address should be associated to. | true |
・リクエストサンプル
$ ./kick_api.sh command=associateIpAddress networkid=dfab0cf8-c56f-437c-9816-14e47d127235
レスポンス
・レスポンスボディ
Response Name | Description |
id | public IP address id |
account | the account the public IP address is associated with |
allocated | date the public IP address was acquired |
associatednetworkid | the ID of the Network associated with the IP address |
associatednetworkname | the name of the Network associated with the IP address |
domain | the domain the public IP address is associated with |
domainid | the domain ID the public IP address is associated with |
fordisplay | is public ip for display to the regular user |
forvirtualnetwork | the virtual network for the IP address |
ipaddress | public IP address |
isportable | is public IP portable across the zones |
issourcenat | true if the IP address is a source nat address, false otherwise |
isstaticnat | true if this ip is for static nat, false otherwise |
issystem | true if this ip is system ip (was allocated as a part of deployVm or createLbRule) |
networkid | the ID of the Network where ip belongs to |
physicalnetworkid | the physical network this belongs to |
project | the project name of the address |
projectid | the project id of the ipaddress |
purpose | purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value |
state | State of the ip address. Can be: Allocatin, Allocated and Releasing |
virtualmachinedisplayname | virutal machine display name the ip address is assigned to (not null only for static nat Ip) |
virtualmachineid | virutal machine id the ip address is assigned to (not null only for static nat Ip) |
virtualmachinename | virutal machine name the ip address is assigned to (not null only for static nat Ip) |
vlanid | the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only |
vlanname | the VLAN associated with the IP address |
vmipaddress | virutal machine (dnat) ip address (not null only for static nat Ip) |
vpcid | VPC the ip belongs to |
zoneid | the ID of the zone the public IP address belongs to |
zonename | the name of the zone the public IP address belongs to |
tags(*) | the list of resource tags associated with ip address |
account | the account associated with the tag |
customer | customer associated with the tag |
domain | the domain associated with the tag |
domainid | the ID of the domain associated with the tag |
key | tag key name |
project | the project name where tag belongs to |
projectid | the project id the tag belongs to |
resourceid | id of the resource |
resourcetype | resource type |
value | tag value |
jobid | the ID of the latest async job acting on this object |
jobstatus | the current status of the latest async job acting on this object |
・レスポンスサンプル
【API実行結果】
<?xml version=”1.0″ encoding=”UTF-8″?>
<associateipaddressresponse cloud-stack-version=”4.3.0.2″>
<id>6a8cb891-ea10-47b0-96c4-f851eeb3b652</id>
<jobid>9153e752-61ca-4369-8ff2-23300b1e2b95</jobid>
</associateipaddressresponse>