Return the List of Container Clusters

Returns information about all Container Clusters.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-clusters

Request Headers:

n/a

Query Parameters:

ContainerClusterPropertiesFilterParameters+

ContainerClusterPropertiesFilterParameters (schema)

Name	Description	Type	Notes
cluster_type	Type of container cluster This is the type of container cluster.	string	Enum: PAS, PKS, Kubernetes, Openshift, WCP, WCP_Guest, AKS, EKS, TKGm, TKGi, GKE, Gardener, Rancher, TAS, Other
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
infra_type	Type of infrastructure This is the type of container's infrastructure.	string	Enum: vSphere, AWS, Azure, Google, VMC, KVM, Baremetal
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-clusters

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerClusterListResult+

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 Clusters	array of ContainerCluster	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": "b8b0889f-338c-5c65-98bd-a5642ae2aa03", "cluster_type": "PKS", "infrastructure": { "infra_type": "AWS" }, "origin_properties": [ { "key": "prop1", "value": "val1" } ], "resource_type": "ContainerCluster", "display_name": "Cluster-1", "_last_sync_time": 1555405468523 }, { "external_id": "b8b0889f-338c-5c65-98bd-a5642ae2aa04", "cluster_type": "Kubernetes", "infrastructure": { "infra_type": "vSphere" }, "origin_properties": [ { "key": "prop2", "value": "val2" } ], "resource_type": "ContainerCluster", "display_name": "Cluster-2", "_last_sync_time": 1555405468659 }, ], "result_count": 2, "sort_by": "displayName", "sort_ascending": true }

Return the List of Container Clusters

Request:

ContainerClusterPropertiesFilterParameters (schema)

Example Request:

Successful Response:

ContainerClusterListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: