Return Compute Collection Information

Returns information about a specific compute collection.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/compute-collections/<cc-ext-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/compute-collections/ead58c04-d19a-11e6-bf26-cec0c932ce01:domain-c32

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ComputeCollection+

ComputeCollection (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
cm_local_id	Local Id of the compute collection in the Compute Manager	string	Required Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC	string	Required Readonly
origin_id	Id of the compute manager from where this Compute Collection was discovered	string	Required Readonly
origin_properties	Key-Value map of additional specific properties of compute collection in the Compute Manager	array of KeyValuePair	Readonly
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	Required Readonly
owner_id	Id of the owner of compute collection in the Compute Manager	string	Readonly
resource_type	Must be set to the value ComputeCollection	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "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", "origin_properties": [] }

Return Compute Collection Information

Request:

Example Request:

Successful Response:

ComputeCollection (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: