Get Floating Ip Suggestions

Get Floating Ip Suggestions

Suggests IP addresses to use for networking services on Edge Gateway or Provider Gateway. "gatewayId" filter is required. Based on the specified Gateway, VCD will query all the applicable IP Spaces and suggest some IP addresses which can be utilized to configure the network services on the Gateway. IP Space IP addresses which are are allocated but not currently used for any network services are considered. Results can also be filtered by IPV4 or IPV6 IP address types. Filter examples:(filter=gatewayId==URN), (filter=gatewayId==URN;ipType==IPV6)

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/ipSpaces/floatingIpSuggestions
COPY
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 IpSpaceFloatingIpSuggestions of type(s) application/json;version=38.1
This response body class contains all of the following: Page , InlineIpSpaceFloatingIpSuggestions1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "ipSpaceRef": {
                "name": "string",
                "id": "string"
            },
            "unusedValues": [
                "string"
            ]
        }
    ]
}