ニフクラAPI (コンピューティング: DescribeAddresses)

DescribeAddresses

処理概要

付替IPアドレスの情報を取得します。
付替IPアドレスを指定しない場合は、取得可能なすべての付替グローバルIPアドレス・プライベートIPアドレス情報を取得します。

また付替IPアドレスを指定する際、ワイルドカード文字（曖昧検索）指定可能です。「*」は0個以上任意文字、 「?」は1個任意文字となります。

指定するパラメーター

パラメーター	型	説明	必須
PublicIp.n	string	グローバルIPアドレス Default: アカウントに属するすべてのIPアドレス
PrivateIpAddress.n	string	プライベートIPアドレス Default: アカウントに属するすべてのIPアドレス
AllocationId.n	string	※指定不可
Filter.n.Name	string	※指定不可
Filter.n.Value.m	string	※指定不可

応答フィールド

フィールド (項目)	型	説明
DescribeAddressesResponse	-	DescribeAddressesレスポンス
␣requestId	string	リクエスト識別子
␣addressesSet	-	IPアドレス情報セット
␣␣item	-	IPアドレス情報
␣␣␣publicIp	string	グローバルIPアドレス
␣␣␣privateIpAddress	string	プライベートIPアドレス
␣␣␣instanceId	string	サーバー名
␣␣␣instanceUniqueId	string	サーバーユニークID
␣␣␣description	string	IPアドレスのメモ
␣␣␣availabilityZone	string	ゾーン情報

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeAddresses
  &PublicIp.1=172.16.2.1
  &CommonParams

  

応答サンプル

    <DescribeAddressesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <addressesSet>
    <item>
      <publicIp>172.16.2.1</publicIp>
      <instanceId>server01</instanceId>
      <instanceUniqueId>i-efba9876</instanceUniqueId>
      <description>IPmemo</description>
      <availabilityZone>east-11</availabilityZone>
    </item>
  </addressesSet>
</DescribeAddressesResponse>