サポートトップ » GMOクラウド Public トップ » APIリファレンス
IPアドレス一覧の取得
指定したネットワークに属するIPアドレスの一覧を返します。
この機能の実行時には以下のパラメーターを指定してください。
| パラメーター | 説明 | 必須 |
|---|---|---|
| network_id | ネットワークID 該当するネットワークIDを指定します ネットワークIDは8.1. listNetworks APIで取得できます 8.1. listNetworksのレスポンスオブジェクトのうち、idが該当します |
○ |
| free | 利用状態 取得するIPアドレスが使用できるか否かでフィルタします true : レスポンスオブジェクトの freeフィールドが true のIPアドレスのみ （使用中ではないIPアドレス） false : レスポンスオブジェクトの freeフィールドが false のIPアドレスのみ （使用中のIPアドレス） なお、このパラメーターを指定しない場合は全てのIPアドレスを取得します |
× |
| Identifier | ネットワークID 古いバージョンのAPIで使用していたパラメーターで、現在は使用しません。 このIdentifier パラメーターが指定されていてもAPIの振る舞いには影響を及ぼしません。 相応の期間経過後にこのパラメーターは廃止します。 |
× |
以下の形式で応答します。
| フィールド | 説明 |
|---|---|
| address | IPアドレスを返します |
| broadcast | 当該IPアドレスが属するネットワークのブロードキャストアドレスを返します |
| created_at | 指定したネットワークで当該IPアドレスが使用可能になった日時を返します 日時は下記のフォーマットで表されます YYYY-MM-DDThh:mm:ssZ |
| disallowed_primary | 仮想サーバー作成時に、当該IPアドレスをプライマリインターフェースで使用できるか否かを返します true : プライマリインターフェースで使用できない false : プライマリインターフェースで使用できる |
| free | 当該IPアドレスが使用中であるか否かを返します true : 使用中ではない false : 使用中 |
| gateway | 当該IPアドレスが属するネットワークのゲートウェイアドレスを返します |
| id | 指定したネットワークにおいてIPアドレスに対して設定されているIDを返します |
| ip_addresses | 指定したネットワークに割り当てられている全てのIPアドレスを返します |
| netmask | 当該IPアドレスのネットマスクを返します |
| network_address | 当該IPアドレスが属するネットワークのネットワークアドレスを返します |
| network_id | 当該ネットワークインターフェースが接続するネットワークIDを返します ネットワークIDは 8.1. listNetworks API で取得できます 8.1. listNetworks API のレスポンスオブジェクトのうち id が該当します |
| updated_at | 指定したネットワークにおける当該IPアドレスの設定が最後にアップデートされた日時を返します 日時は下記のフォーマットで表されます YYYY-MM-DDThh:mm:ssZ |
https://api.gmocloud.com/Cloud-Zone-ID/?Action=listIpAddresses&AccessKeyId=AccessKeyId&Version=1.0&network_id=ID_of_Network&free=true&Signature=Signature
{
"ID_of_IPaddress": {
"netmask": "255.255.255.0",
"disallowed_primary": false,
"address": "192.168.0.100",
"created_at": "2012-06-13T19:59:39+09:00",
"network_address": "192.168.0.0",
"network_id": ID_of_Network,
"updated_at": "2012-06-13T19:59:39+09:00",
"broadcast": "192.168.0.255",
"id": ID_of_IPaddress,
"free": false,
"gateway": "192.168.0.254"
}
}
