Get Ip Space Summaries

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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns IpSpaceSummaries of type(s) application/json;version=39.1
This response body class contains all of the following: InlineIpSpaceSummaries0 , InlineIpSpaceSummaries1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": {},
            "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
                        }
                    ]
                }
            }
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/ipSpaces/summaries?page=value&pageSize=v
Availability
Added in 37.1
On This Page
Ip Spaces Operations
POST
Apply Ip Space Default Edge Gateway Services
GET
Get Ip Space Summaries
POST
Create Ip Space
GET
Get Floating Ip Suggestions
GET
Get Ip Prefix Suggestions
GET
Get Ip Prefix Sequences
GET
Get Ip Space
PUT
Update Ip Space
DELETE
Delete Ip Space
POST
Allocate
GET
Get Ip Space Ip Allocations
GET
Get Ip Space Ip Allocation
PUT
Update Ip Space Ip Allocation
DELETE
Delete Ip Space Ip Allocation
POST
Apply Ip Space Default Provider Gateway Services