Managed Services for Kubernetes API, REST: Cluster.listNodes
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 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.
|
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 |
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 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 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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
nodes[]. kubernetesStatus. conditions[]. lastTransitionTime |
string (date-time) Last time the condition transit from one status to another. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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.
|
nodes[]. kubernetesStatus. attachedVolumes[] |
object List of volumes that are attached to the 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 |