List Container Ip Pool

Returns information about all container ip pools.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/fabric/container-ip-pools

COPY

Query Parameters

string

container_cluster_id

Optional

Identifier of the container cluster

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

string

scope_id

Optional

Scope id for container cluster

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns ContainerIpPoolListResult of type(s) application/json

This response body class contains all of the following: InlineContainerIpPoolListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_last_sync_time": 0,
            "description": "string",
            "display_name": "string",
            "resource_type": "string",
            "scope": [
                {
                    "scope_id": "string",
                    "scope_type": "string"
                }
            ],
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "container_cluster_id": "string",
            "external_id": "string",
            "ip_ranges": [
                {
                    "cidr": "string",
                    "end": "string",
                    "gateway": "string",
                    "prefix_length": 0,
                    "start": "string",
                    "vlan": 0
                }
            ],
            "ip_version": 0,
            "origin_properties": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "spec": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json