Get Used Ip Addresses

Get Used Ip Addresses

Get 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
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UsedIpAddresses of type(s) application/json;version=38.1
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,
            "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=38.1 
{
    "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
Edge Gateway Operations
DELETE
Delete Edge Gateway
GET
Get Edge Gateway
GET
Get Used Ip Addresses
PUT
Update Edge Gateway