Get Used Ip Addresses
Get all the used IPs for a given external network. This returns all the IP addresses of network which are being used by a vApp VM or by an edge gateway connected to this external network. Results can be filtered by IP address.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/usedIpAddresses
COPY
Path Parameters
string
externalNetworkId
Required
externalNetworkId
string
externalNetworkId
Required
externalNetworkId
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns UsedIpAddresses of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineUsedIpAddresses1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"entityId": "string",
"entityName": "string",
"vAppName": "string",
"ipAddress": "string",
"deployed": false,
"allocationType": {},
"networkRef": {
"name": "string",
"id": "string"
},
"orgRef": {
"name": "string",
"id": "string"
}
}
]
}
404
The specified resource was not found
Returns Error of type(s) application/json;version=39.0
{
"minorErrorCode": "string",
"message": "string",
"stackTrace": "string"
}
string
minorErrorCode
Required
minorErrorCode
string
message
Required
message
string
stackTrace
Optional
stackTrace
Availability
Added in 33.0
On This Page
External Network Operations
DELETE
Delete External Network
GET
Get Available Ip Addresses
GET
Get Edge Gateways For Provider Gateway Topology
GET
Get External Network
GET
Get Ip Space Uplinks For Provider Gateway Topology
GET
Get Provider Gateway Ip Space Migration Violations
GET
Get Used Ip Addresses
POST
Migrate Provider Gateway To Use Ip Spaces
PUT
Update External Network