Get Ip Space Ip Allocations

Retrieves all the allocated IP addresses or IP Prefixes of an IP Space. The allocation type is required to be specified in the filter. example: (type==FLOATING_IP).

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocations

COPY

Path Parameters

string

ipSpaceId

Required

ipSpaceId

string

ipSpaceId

Required

ipSpaceId

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.

ApiKeyAuth

Responses

200

Returns IpSpaceIpAllocations of type(s) application/json;version=39.0

This response body class contains all of the following: Page , InlineIpSpaceIpAllocations1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "urn:vcloud:ipSpaceIpAllocation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "type": "string",
            "value": "string",
            "allocationDate": "string",
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "usageState": "string",
            "description": "string",
            "reservedForUser": false,
            "reservedForUserName": "string",
            "usedByRef": {
                "name": "string",
                "id": "string"
            },
            "usageCategories": [
                "string"
            ],
            "purpose": "string"
        }
    ]
}

Availability

Added in 37.1

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Ip Spaces Operations

POST