Get Ip Space Summaries

Get all the IP space summaries in the system.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/ipSpaces/summaries

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.

ApiKeyAuth

Responses

200

Returns IpSpaceSummaries of type(s) application/json;version=37.2

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

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "urn:vcloud:ipSpace:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "string",
            "description": "string",
            "type": "string",
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "utilization": {
                "floatingIPs": {
                    "totalCount": "string",
                    "allocatedCount": "string",
                    "usedCount": "string",
                    "unusedCount": "string",
                    "allocatedPercentage": "number",
                    "usedPercentage": "number"
                },
                "ipPrefixes": {
                    "prefixLengthUtilizations": [
                        {
                            "prefixLength": 0,
                            "totalCount": 0,
                            "allocatedCount": 0
                        }
                    ]
                }
            }
        }
    ]
}

Availability

Added in 37.1

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Ip Spaces Operations

POST

Allocate