Method get

HTTP request
Path parameters
Response

Returns the specified Kubernetes cluster.

To get the list of available Kubernetes cluster, make a list request.

HTTP request

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

Path parameters

Parameter	Description
clusterId	Required. ID of the Kubernetes cluster to return.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string",
  "health": "string",
  "networkId": "string",
  "master": {
    "version": "string",
    "endpoints": {
      "internalV4Endpoint": "string",
      "externalV4Endpoint": "string"
    },
    "masterAuth": {
      "clusterCaCertificate": "string"
    },
    "versionInfo": {
      "currentVersion": "string",
      "newRevisionAvailable": true,
      "newRevisionSummary": "string",
      "versionDeprecated": true
    },
    "maintenancePolicy": {
      "autoUpgrade": true,
      "maintenanceWindow": {

        // `master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
        "anytime": {},
        "dailyMaintenanceWindow": {
          "startTime": {
            "hours": "integer",
            "minutes": "integer",
            "seconds": "integer",
            "nanos": "integer"
          },
          "duration": "string"
        },
        "weeklyMaintenanceWindow": {
          "daysOfWeek": [
            {
              "days": [
                "string"
              ],
              "startTime": {
                "hours": "integer",
                "minutes": "integer",
                "seconds": "integer",
                "nanos": "integer"
              },
              "duration": "string"
            }
          ]
        },
        // end of the list of possible fields`master.maintenancePolicy.maintenanceWindow`

      }
    },
    "securityGroupIds": [
      "string"
    ],

    // `master` includes only one of the fields `zonalMaster`, `regionalMaster`
    "zonalMaster": {
      "zoneId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string"
    },
    "regionalMaster": {
      "regionId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string"
    },
    // end of the list of possible fields`master`

  },
  "ipAllocationPolicy": {
    "clusterIpv4CidrBlock": "string",
    "nodeIpv4CidrMaskSize": "string",
    "serviceIpv4CidrBlock": "string",
    "clusterIpv6CidrBlock": "string",
    "serviceIpv6CidrBlock": "string"
  },
  "serviceAccountId": "string",
  "nodeServiceAccountId": "string",
  "releaseChannel": "string",
  "networkPolicy": {
    "provider": "string"
  },
  "kmsProvider": {
    "keyId": "string"
  },
  "logGroupId": "string",
  "gatewayIpv4Address": "string"
}

A Kubernetes cluster.

Field	Description
id	string ID of the Kubernetes cluster.
folderId	string ID of the folder that the Kubernetes cluster belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	object Resource labels as `key:value` pairs. Maximum of 64 per resource.
status	string Status of the Kubernetes cluster. PROVISIONING: Kubernetes cluster is waiting for resources to be allocated. RUNNING: Kubernetes cluster is running. RECONCILING: Kubernetes cluster is being reconciled. STOPPING: Kubernetes cluster is being stopped. STOPPED: Kubernetes cluster stopped. DELETING: Kubernetes cluster is being deleted. STARTING: Kubernetes cluster is being started.
health	string Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
networkId	string ID of the network the Kubernetes cluster belongs to.
master	object Properties of the master for the Kubernetes cluster.
master. version	string Version of Kubernetes components that runs on the master.
master. endpoints	object Endpoints of the master. Endpoints constitute of scheme and port (i.e. `https://ip-address:port`) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster.
master. endpoints. internalV4Endpoint	string Internal endpoint that can be used to connect to the master from cloud networks.
master. endpoints. externalV4Endpoint	string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
master. masterAuth	object Master authentication parameters are used to establish trust between the master and a client.
master. masterAuth. clusterCaCertificate	string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
master. versionInfo	object Detailed information about the Kubernetes version that is running on the master.
master. versionInfo. currentVersion	string Current Kubernetes version, format: major.minor (e.g. 1.15).
master. versionInfo. newRevisionAvailable	boolean (boolean) Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in Yandex specific components either on the master or nodes.
master. versionInfo. newRevisionSummary	string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
master. versionInfo. versionDeprecated	boolean (boolean) The current version is on the deprecation schedule, component (master or node group) should be upgraded.
master. maintenancePolicy	object Maintenance policy of the master.
master. maintenancePolicy. autoUpgrade	boolean (boolean) If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled.
master. maintenancePolicy. maintenanceWindow	object Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC.
master. maintenancePolicy. maintenanceWindow. anytime	object Updating the master at any time. `master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow	object Updating the master on any day during the specified time window. `master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime	object Required. Window start time, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. duration	string Window duration. Acceptable values are 3600 seconds to 86400 seconds, inclusive.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow	object Updating the master on selected days during the specified time window. `master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]	object Required. Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. days[]	string Represents a day of week. DAY_OF_WEEK_UNSPECIFIED: The unspecified day-of-week. MONDAY: The day-of-week of Monday. TUESDAY: The day-of-week of Tuesday. WEDNESDAY: The day-of-week of Wednesday. THURSDAY: The day-of-week of Thursday. FRIDAY: The day-of-week of Friday. SATURDAY: The day-of-week of Saturday. SUNDAY: The day-of-week of Sunday.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime	object Required. Window start time, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. duration	string Window duration. Acceptable values are 3600 seconds to 86400 seconds, inclusive.
master. securityGroupIds[]	string Master security groups.
master. zonalMaster	object Parameters of the availability zone for the master. `master` includes only one of the fields `zonalMaster`, `regionalMaster`
master. zonalMaster. zoneId	string ID of the availability zone where the master resides.
master. zonalMaster. internalV4Address	string IPv4 internal network address that is assigned to the master.
master. zonalMaster. externalV4Address	string IPv4 external network address that is assigned to the master.
master. regionalMaster	object Parameters of the region for the master. `master` includes only one of the fields `zonalMaster`, `regionalMaster`
master. regionalMaster. regionId	string ID of the region where the master resides.
master. regionalMaster. internalV4Address	string IPv4 internal network address that is assigned to the master.
master. regionalMaster. externalV4Address	string IPv4 external network address that is assigned to the master.
ipAllocationPolicy	object Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
ipAllocationPolicy. clusterIpv4CidrBlock	string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets.
ipAllocationPolicy. nodeIpv4CidrMaskSize	string (int64) Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be one of 0, 24, 25, 26, 27 or 28.
ipAllocationPolicy. serviceIpv4CidrBlock	string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in.
ipAllocationPolicy. clusterIpv6CidrBlock	string IPv6 range for allocating pod IP addresses.
ipAllocationPolicy. serviceIpv6CidrBlock	string IPv6 range for allocating Kubernetes service IP addresses
serviceAccountId	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
nodeServiceAccountId	string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
releaseChannel	string When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation. RAPID: Minor updates with new functions and improvements are often added. You can't disable automatic updates in this channel, but you can specify a time period for automatic updates. REGULAR: New functions and improvements are added in chunks shortly after they appear on `RAPID`. STABLE: Only updates related to bug fixes or security improvements are added.
networkPolicy	object
networkPolicy. provider	string
kmsProvider	object KMS provider configuration.
kmsProvider. keyId	string KMS key ID for secrets encryption. To obtain a KMS key ID use a list request.
logGroupId	string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
gatewayIpv4Address	string Gateway IPv4 address. The maximum string length in characters is 15.