NSX-T Data Center REST API

Return the list of container cluster nodes

Returns information about all container cluster nodes.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-cluster-nodes

Request Headers:

n/a

Query Parameters:

ContainerClusterFilterParameters+

ContainerClusterFilterParameters (schema)

Name	Description	Type	Notes
container_cluster_id	Identifier of the container cluster Identifier of the container cluster.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	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
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
scope_id	Scope id for container cluster Specifies scope id for container cluster. Default value is same as identifier of the cluster.	string
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/container-cluster-nodes

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerClusterNodeListResult+

ContainerClusterNodeListResult (schema)

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	List of container cluster nodes	array of ContainerClusterNode	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:

{ "results": [ { "external_id": "cdd8569c-5934-11e9-b657-000c296a0506", "container_cluster_id": "a19ad270-6026-11e9-980c-dca9048e157d", "tags": [ { "scope": "dis:k8s:key", "tag": "val" } ], "origin_properties": [], "resource_type": "ContainerClusterNode", "display_name": "sc2-rdops-vm02-dhcp-70-93", "_last_sync_time": 1555666926606 } ], "result_count": 1, "sort_by": "displayName", "sort_ascending": true }

Required Permissions:

read

Feature:

containers_inventory

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable