List Compute Collections

Returns information about all compute collections.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/fabric/compute-collections

COPY

Query Parameters

string

cm_local_id

Optional

Local Id of the compute collection in the Compute Manager

string

cursor

Optional

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

string

discovered_node_id

Optional

Id of the discovered node which belongs to this Compute Collection

string

display_name

Optional

Name of the ComputeCollection in source compute manager

string

external_id

Optional

External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC

string

included_fields

Optional

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

string

node_id

Optional

Id of the fabric node created from a discovered node belonging to this Compute Collection

string

origin_id

Optional

Id of the compute manager from where this Compute Collection was discovered

string

origin_type

Optional

ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers

string

owner_id

Optional

Id of the owner of compute collection in the Compute Manager

integer

page_size

Optional

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

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 ComputeCollectionListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineComputeCollectionListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_last_sync_time": 0,
            "display_name": "string",
            "description": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "origin_id": "string",
            "origin_properties": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "external_id": "string",
            "owner_id": "string",
            "origin_type": "string",
            "cm_local_id": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json