- HOME
- 提供API一覧
- listPublicIpAddresses
listPublicIpAddresses
処理概要
パブリックIPアドレス情報を取得
注意事項
・なし
リクエスト
・リクエストパラメータ
| Parameter Name | Description | Required |
| associatednetworkid | lists all public IP addresses associated to the network specified | false |
| forloadbalancing | list only IPs used for load balancing | false |
| id | lists IP address by ID | false |
| ipaddress | lists the specified IP address | false |
| issourcenat | list only source NAT IP addresses | false |
| isstaticnat | list only static NAT IP addresses | false |
| keyword | List by keyword | false |
| tags | List resources by tags (key/value pairs) | false |
| zoneid | lists all public IP addresses by zone ID | false |
・リクエストサンプル
$ ./kick_api.sh command=listPublicIpAddresses issourcenat=true
レスポンス
・レスポンスボディ
| 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″?>
<listpublicipaddressesresponse cloud-stack-version=”4.3.0.2″>
<count>1</count>
<publicipaddress>
<id>c26ea398-7d6e-4a09-a64e-e9db881a44e3</id>
<ipaddress>27.XX.XX.101</ipaddress>
<allocated>2015-03-11T14:06:59+0900</allocated>
<zoneid>0bce0eae-9d21-4a67-a671-ec632e70908f</zoneid>
<zonename>jp2-west01</zonename>
<issourcenat>true</issourcenat>
<account>xxxx</account>
<domainid>3d852d53-f1df-4de0-a0af-dcbbd1d3e56f</domainid>
<domain>MXXXXXXXX</domain>
<forvirtualnetwork>true</forvirtualnetwork>
<isstaticnat>false</isstaticnat>
<issystem>false</issystem>
<associatednetworkid>cc9ce6f4-67eb-4313-8fc4-763836d1da6b</associatednetworkid>
<associatednetworkname>PublicFrontSegment</associatednetworkname>
<networkid>14342c98-41fe-4ca0-82d1-34d6f5aa589f</networkid>
<state>Allocated</state>
<physicalnetworkid>2883450b-d81d-4884-ad82-6b277279852d</physicalnetworkid>
<isportable>false</isportable>
</publicipaddress>
</listpublicipaddressesresponse>