本文へジャンプします。

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

DescribeAddresses

処理概要

付替IPアドレスの情報を取得します。
付替IPアドレスを指定しない場合は、取得可能なすべての付替グローバルIPアドレス・プライベートIPアドレス情報を取得します。
解放済みの付替IPアドレスを指定した、管理外の付替IPアドレスを指定したなど、無効なIPアドレスを指定した場合は、エラーが返されます。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
PublicIp.n グローバルIPアドレス
Default : アカウントに属するすべてのIPアドレス
Type : String
   
PublicIp.n グローバルIPアドレス
Default : アカウントに属するすべてのIPアドレス
Type : String
   
PublicIp.n グローバルIPアドレス
Default : アカウントに属するすべてのIPアドレス
Type : String
   
PublicIp.n グローバルIPアドレス
Default : アカウントに属するすべてのIPアドレス
Type : String
   
PublicIp.n グローバルIPアドレス
Default : アカウントに属するすべてのIPアドレス
Type : String
   

応答フィールド

フィールド 説明 サンプル値
DescribeAddressesResponse DescribeAddressesレスポンス
Type : DescribeAddressesResponseType
Ancestor : なし
Children : requestId, addressesSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeAddressesResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
addressesSet IPアドレス情報セット
Type : DescribeAddressesResponseInfoType
Ancestor : DescribeAddressesResponse
Children : item
 
item IPアドレス情報
Type : DescribeAddressesResponseItemType
Ancestor : addressesSet
Children : publicIp, privateIpAddress, allocationId, domain, instanceId, instanceUniqueId, associationId, networkInterfaceId, networkInterfaceOwnerId, description, availabilityZone
 
publicIp グローバルIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddress プライベートIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
allocationId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
domain ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
 
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
associationId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
networkInterfaceId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
networkInterfaceOwnerId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
description IPアドレスのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeAddresses&PublicIp.1=172.16.2.1&CommonParams

応答サンプル

<DescribeAddressesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>f6dd8353-eb6b-6b4fd32e4f06</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>

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

APIメニュー

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

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