Nodepool Resource Service List

List Nodepools.

Request

URI

GET

https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/managementclusters/{searchScope.managementClusterName}/provisioners/{searchScope.provisionerName}/tanzukubernetesclusters/{searchScope.tanzuKubernetesClusterName}/nodepools

COPY

Path Parameters

string

searchScope.managementClusterName

Required

Scope search to the specified management_cluster_name; supports globbing; default (*).

string

searchScope.provisionerName

Required

Scope search to the specified provisioner_name; supports globbing; default (*).

string

searchScope.tanzuKubernetesClusterName

Required

Scope search to the specified tanzu_kubernetes_cluster_name; supports globbing; default (*).

Query Parameters

string

searchScope.name

Optional

Scope search to the specified name; supports globbing; default (*).

string

sortBy

Optional

Sort Order.

string

query

Optional

TQL query string.

string

pagination.offset

Optional

Offset at which to start returning records.

string

pagination.size

Optional

Number of records to return.

boolean

includeTotalCount

Optional

Include total count.

Responses

200

A successful response.

Returns vmware.tanzu.manage.v1alpha1.managementcluster.provisioner.tanzukubernetescluster.nodepool.ListNodepoolsResponse of type(s) */*

{
    "nodepools": [
        {
            "type": {
                "kind": "string",
                "version": "string",
                "package": "string"
            },
            "fullName": {
                "orgId": "string",
                "managementClusterName": "string",
                "provisionerName": "string",
                "tanzuKubernetesClusterName": "string",
                "name": "string"
            },
            "meta": {
                "uid": "string",
                "generation": "string",
                "resourceVersion": "string",
                "creationTime": "string",
                "updateTime": "string",
                "description": "string",
                "parentReferences": [
                    {
                        "rid": "string",
                        "uid": "string"
                    }
                ]
            },
            "spec": {
                "class": "string",
                "replicas": 0,
                "failureDomain": "string",
                "overrides": [
                    {
                        "name": "string"
                    }
                ],
                "metadata": {},
                "osImage": {
                    "name": "string",
                    "version": "string",
                    "arch": "string"
                }
            },
            "status": {
                "phase": "string"
            }
        }
    ],
    "totalCount": "string"
}

default

An unexpected error response.

Returns grpc.gateway.runtime.Error of type(s) */*

{
    "error": "string",
    "code": 0,
    "message": "string",
    "details": [
        {
            "typeUrl": "string",
            "value": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

Nodepool Resource Service Operations

POST

Nodepool Resource Service Create

POST