Get K8 Cluster Node Pool

Get K8 cluster node pool

Request

URI

GET

https://{api_host}/hybridity/api//infra/k8s/cluster/{clusterId}/nodepool/{nodePoolId}

COPY

Path Parameters

string

clusterId

Required

clusterId

string

nodePoolId

Required

nodePoolId

Header Parameters

string

skip-nodes-info

Optional

Flag to skip nodes information as part of api response. If set to true, response will not have nodes information. Nodes information can be queried directly from Kubernetes cluster API instead. Nodes belonging to a nodepool can be filtered by label with key telco.vmware.com/nodepool and value clustername-nodepoolname.

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

200

returns cluster with given id

Returns nodePool of type(s) application/json

{
    "placementParams": [
        {
            "name": "name",
            "type": "type"
        },
        {
            "name": "name",
            "type": "type"
        }
    ],
    "isNodeCustomizationDeprecated": true,
    "memory": 2048,
    "replica": 1,
    "activeTasksCount": 2,
    "warnings": [
        {
            "errorCode": "errorCode",
            "operationType": "operationType",
            "message": "message",
            "internalMessage": "internalMessage"
        },
        {
            "errorCode": "errorCode",
            "operationType": "operationType",
            "message": "message",
            "internalMessage": "internalMessage"
        }
    ],
    "cpu": 2,
    "storage": 5,
    "networks": [
        {
            "networkFullPath": "networkFullPath",
            "nameservers": [
                "nameservers",
                "nameservers"
            ],
            "derivedFromCsar": true,
            "networkName": "networkName",
            "label": "label",
            "isManagement": true,
            "mtu": 2599
        },
        {
            "networkFullPath": "networkFullPath",
            "nameservers": [
                "nameservers",
                "nameservers"
            ],
            "derivedFromCsar": true,
            "networkName": "networkName",
            "label": "label",
            "isManagement": true,
            "mtu": 2599
        }
    ],
    "labels": [
        "labels",
        "labels"
    ],
    "cloneMode": "fullClone",
    "nodes": [
        {
            "vmName": "vmName",
            "ip": "ip"
        },
        {
            "vmName": "vmName",
            "ip": "ip"
        }
    ],
    "name": "name",
    "id": "id",
    "config": {
        "healthCheck": {
            "unhealthyConditions": [
                {
                    "type": "Ready",
                    "timeout": "timeout",
                    "status": true
                },
                {
                    "type": "Ready",
                    "timeout": "timeout",
                    "status": true
                }
            ],
            "nodeStartupTimeout": "20m0s"
        },
        "cpuManagerPolicy": {
            "type": "kubernetes",
            "properties": {
                "systemReserved": {
                    "memoryInGiB": 1,
                    "cpu": 1
                },
                "kubeReserved": {
                    "memoryInGiB": 1,
                    "cpu": 1
                }
            },
            "policy": "static"
        }
    },
    "errors": [
        {
            "errorCode": "errorCode",
            "operationType": "operationType",
            "message": "message",
            "internalMessage": "internalMessage"
        },
        {
            "errorCode": "errorCode",
            "operationType": "operationType",
            "message": "message",
            "internalMessage": "internalMessage"
        }
    ],
    "status": "status"
}

string

cloneMode

Optional

Key to indicate the use of linked cloning feature for cloning the VMs. If set to linkedClone, then linked cloning will be used.

Possible values are : fullClone, linkedClone,

integer

cpu

Required

Number of virtual CPUs for worker nodes.

string

Optional

array of string

labels

Required

These labels are attached to the nodes. You can use these labels as node selectors when instantiating a network function.

integer

memory

Required

Memory size in MB for worker nodes.

string As [a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9])

name

Required

name

array of nodePool_networks

networks

Required

Network labels for worker nodes. These labels are used for providing network inputs during a cluster deployment. The Management interface label is mandatory.

array of clusterRequest_placementParams

placementParams

Required

placementParams

integer

replica

Required

Replica count for worker nodes.

integer

storage

Required

Disk size in GB for worker nodes.