[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Get Used IP Addresses
DescriptionGet all the IP Addresses which are being used by the Edge Gateway such as the primary IP or an IP used by a given Edge Service, such as NAT. These IP addresses are a subset of the IPs allocated from the connected external networks. If the IP is being consumed by any of the configured services on the edge gateway then name of service will be returned.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/usedIpAddresses
Path Parameters
Path Parameters
string
gatewayId
Required
Query Parameters
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
GatewayUsedIpAddresses
of type(s) application/json;version=36.3
This response body class contains all of the following:
Page, InlineGatewayUsedIpAddresses1
Errors
Error
404
The specified resource was not found
Code Samples
cURL Command
curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/usedIpAddresses?page=10&pageSize=10
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 33.0
