Return the List of Compute Collections

Returns information about all compute collections.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/compute-collections

Request Headers:

n/a

Query Parameters:

ComputeCollectionListRequestParameters+

ComputeCollectionListRequestParameters (schema)

Name	Description	Type	Notes
cm_local_id	Local Id of the compute collection in the Compute Manager	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
discovered_node_id	Id of the discovered node which belongs to this Compute Collection	string
display_name	Name of the ComputeCollection in source compute manager	string
external_id	External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
node_id	Id of the fabric node created from a discovered node belonging to this Compute Collection	string
origin_id	Id of the compute manager from where this Compute Collection was discovered	string
origin_type	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	Id of the owner of compute collection in the Compute Manager	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/compute-collections

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ComputeCollectionListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Compute Collection list results	array of ComputeCollection	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "003653b55e00-e5c1-11e5-a549-005056b18ef8", "result_count": 2, "results": [ { "display_name": "cluster-2", "origin_type": "VC_Cluster", "external_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01:domain-c34", "origin_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01", "cm_local_id": "domain-c34", "owner_nsx": SELF, "origin_properties": [] }, { "display_name": "cluster-1", "origin_type": "VC_Cluster", "external_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01:domain-c32", "origin_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01", "cm_local_id": "domain-c32", "owner_nsx": SELF, "origin_properties": [] } ] }

Return the List of Compute Collections

Request:

ComputeCollectionListRequestParameters (schema)

Example Request:

Successful Response:

ComputeCollectionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: