Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Managed Service for Kubernetes
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Connecting to a node over SSH
    • Creating a configuration file
    • Configuring a Kubernetes cluster network
      • Granting access to an app running in a Kubernetes cluster
      • Using Kubernetes cluster network policies
    • Encrypting secrets
    • Using persistent volumes
      • Dynamically preparing volumes
      • Statically preparing volumes
      • Managing storage classes
      • Expanding a volume
      • Mounting a volume in Block mode
    • Managing a Kubernetes cluster
      • Adding Kubernetes cluster credentials to the kubectl configuration file
      • Getting information about a Kubernetes cluster
      • Creating a Kubernetes cluster
      • Editing a Kubernetes cluster
      • Deleting a Kubernetes cluster
    • Managing a node group
      • Getting information about a node group
      • Creating a node group
      • Editing a node group
      • Deleting a node group
  • Solutions
    • Integration with Container Registry
    • Running workloads with GPUs
    • Making backups to Object Storage
  • Concepts
    • Relationship between service resources
    • Release channels and updates
    • Using Kubernetes API objects
      • Volume
      • Service
    • Node group
      • Autoscaling node groups
      • Evicting pods from a node
      • Dynamic resource allocation for a node
      • Node groups with GPUs
    • Kubernetes cluster network policies
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ClusterService
      • NodeGroupService
      • VersionService
      • OperationService
    • REST
      • Overview
      • Cluster
        • Overview
        • create
        • delete
        • get
        • list
        • listNodeGroups
        • listNodes
        • listOperations
        • start
        • stop
        • update
      • NodeGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listNodes
        • listOperations
        • update
      • Version
        • Overview
        • list
  • Questions and answers
  1. API reference
  2. REST
  3. Cluster
  4. listNodes

Method listNodes

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Lists cluster's nodes.

HTTP request

GET https://mks.api.cloud.yandex.net/managed-kubernetes/v1/clusters/{clusterId}/nodes

Path parameters

Parameter Description
clusterId Required. ID of the Kubernetes cluster to list nodes in. To get the Kubernetes cluster ID use a list request.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "nodes": [
    {
      "status": "string",
      "spec": {
        "resources": {
          "memory": "string",
          "cores": "string",
          "coreFraction": "string",
          "gpus": "string"
        },
        "disk": {
          "diskTypeId": "string",
          "diskSize": "string"
        }
      },
      "cloudStatus": {
        "id": "string",
        "status": "string",
        "statusMessage": "string"
      },
      "kubernetesStatus": {
        "id": "string",
        "conditions": [
          {
            "type": "string",
            "status": "string",
            "message": "string",
            "lastHeartbeatTime": "string",
            "lastTransitionTime": "string"
          }
        ],
        "taints": [
          {
            "key": "string",
            "value": "string",
            "effect": "string"
          }
        ],
        "attachedVolumes": [
          {
            "driverName": "string",
            "volumeHandle": "string"
          }
        ]
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
nodes[] object

List of nodes for the specified Kubernetes cluster.

nodes[].
status
string

Computed node status.

Computed node status.

  • PROVISIONING: Node instance is not yet created (e.g. in progress).
  • NOT_CONNECTED: Node instance is created but not registered (e.g. is still initializing).
  • NOT_READY: Node has connected but is not ready for workload (see conditions for details).
  • READY: Node has connected and ready for workload.
  • MISSING: Node is still registered but its instance is deleted (this is our bug).
nodes[].
spec
object

Node specificaion.

Node specification.

nodes[].
spec.
resources
object

Node group specified resources.

nodes[].
spec.
resources.
memory
string (int64)

Amount of memory available to the node, specified in bytes.

The minimum value is 0.

nodes[].
spec.
resources.
cores
string (int64)

Number of cores available to the node.

The minimum value is 0.

nodes[].
spec.
resources.
coreFraction
string (int64)

Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core.

Acceptable values are 0 to 100, inclusive.

nodes[].
spec.
resources.
gpus
string (int64)

Number of GPUs available to the node.

The minimum value is 0.

nodes[].
spec.
disk
object

Node group specified disk.

nodes[].
spec.
disk.
diskTypeId
string

ID of the disk type.

Value must match the regular expression \|network-ssd\|network-hdd.

nodes[].
spec.
disk.
diskSize
string (int64)

Size of the disk, specified in bytes.

Acceptable values are 0 to 4398046511104, inclusive.

nodes[].
cloudStatus
object

Cloud instance status. Not available in MISSING status.

Cloud instance info

nodes[].
cloudStatus.
id
string

Compute instance id

nodes[].
cloudStatus.
status
string

IG instance status

nodes[].
cloudStatus.
statusMessage
string

IG instance status message

nodes[].
kubernetesStatus
object

Kubernetes node status. Not available in PROVISIONING and NOT_CONNECTED states.

Kubernetes node info

nodes[].
kubernetesStatus.
id
string

Node id (and instance name)

nodes[].
kubernetesStatus.
conditions[]
object

Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

nodes[].
kubernetesStatus.
conditions[].
type
string

Type of node condition.

nodes[].
kubernetesStatus.
conditions[].
status
string

Status is the status of the condition.

nodes[].
kubernetesStatus.
conditions[].
message
string

Human-readable message indicating details about last transition.

nodes[].
kubernetesStatus.
conditions[].
lastHeartbeatTime
string (date-time)

Last time we got an update on a given condition.

String in RFC3339 text format.

nodes[].
kubernetesStatus.
conditions[].
lastTransitionTime
string (date-time)

Last time the condition transit from one status to another.

String in RFC3339 text format.

nodes[].
kubernetesStatus.
taints[]
object

If specified, the node's taints.

nodes[].
kubernetesStatus.
taints[].
key
string

The taint key to be applied to a node.

nodes[].
kubernetesStatus.
taints[].
value
string

The taint value corresponding to the taint key.

nodes[].
kubernetesStatus.
taints[].
effect
string

The effect of the taint on pods that do not tolerate the taint.

  • NO_SCHEDULE: Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running.
  • PREFER_NO_SCHEDULE: Like NO_SCHEDULE, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
  • NO_EXECUTE: Evict any already-running pods that do not tolerate the taint.
nodes[].
kubernetesStatus.
attachedVolumes[]
object

AttachedVolume describes a volume attached to a node

nodes[].
kubernetesStatus.
attachedVolumes[].
driverName
string

Name of the driver which has attached the volume

nodes[].
kubernetesStatus.
attachedVolumes[].
volumeHandle
string

Volume handle (cloud disk id)

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the next_page_token as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC