[IP Addresses] listIpAddresses

listIpAddresses

Process Overview of the Function

List of IP addresses belonging to the specified network is returned.

Request Parameters

Specify the following parameter(s) when executing this function.

ParameterDescriptionRequired
network_id

Network ID

Specify the Network ID.
The network ID can be obtained from the 8.1. listNetworks function.
In the 8.1. listNetworks function response object, the corresponding field is, id.

free

Availability Status

Filters the retrieved IP addresses for availability for use.

true : Only those IP addresses where the response objects field, free, is true.
(IP address not in use)
false : Only those IP addresses where the response objects field, free, is false.
(IP address in use)
If this parameter is not specified, all the IP addresses are retrieved.

×
Identifier

Network ID

This parameter was used in older version of API, and currently is not in use.
Even if the Identifier parameter is specified it will not change the behavior of the API.
This parameter will be deleted after a suitable period of time.

×

 

Response Object

The following format is used in the response.

FieldDescription
address

Returns the IP address.

broadcast

Returns the broadcast address of the network to which the appropriate IP address belongs.

created_at

Returns the date and time the appropriate IP address became available for use on the specified network.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

disallowed_primary

Returns whether the appropriate IP address can be used in the primary interface at virtual server deploy time.

true : Can not be used in primary interface
false : Can be used in primary interface

free

Returns whether the appropriate IP address is being used or not.

true : Not in use
false : In use

gateway Returns the gateway address of the network to which the appropriate IP address belongs.
id Returns the ID assigned to the IP address in the specified network.
ip_addresses Returns all the IP addresses allocated to the specified network.
netmask Returns the netmask of the appropriate IP address
network_address Returns the network address of the network to which the appropriate IP address belongs.
network_id Returns the ID of the network to which the appropriate network interface is to connect.
The network ID can be obtained from the 8.1. listNetworks function.
In the 8.1. listNetworks function response object, the corresponding field is, id.
updated_at

Returns the date and time the setting of appropriate IP address in the specified network is last updated.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

 

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listIpAddresses&AccessKeyId=AccessKeyId&Version=1.0&network_id=ID_of_Network&free=true&Signature=Signature

Response Sample

{
"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"
}
}

Note: GMO CLOUD AMERICA INC. does not make any guarantee with regard to the content of this manual and will not be held responsible for any damages resulting from customers or third parties.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk