Method list

HTTP request
Query parameters
Response

Retrieves the list of Kubernetes cluster in the specified folder.

HTTP request

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

Query parameters

Parameter	Description
folderId	Required. ID of the folder to list Kubernetes cluster in. To get the folder ID use a list request.
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 pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter	A filter expression that filters resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on Cluster.name field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be 1-61 characters long and match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "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": {

            // `clusters[].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`clusters[].master.maintenancePolicy.maintenanceWindow`

          }
        },

        // `clusters[].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`clusters[].master`

      },
      "ipAllocationPolicy": {
        "clusterIpv4CidrBlock": "string",
        "serviceIpv4CidrBlock": "string"
      },
      "serviceAccountId": "string",
      "nodeServiceAccountId": "string",
      "releaseChannel": "string",
      "networkPolicy": {
        "provider": "string"
      },
      "gatewayIpv4Address": "string"
    }
  ],
  "nextPageToken": "string"
}

Field	Description
clusters[]	object A Kubernetes cluster.
clusters[]. id	string ID of the Kubernetes cluster.
clusters[]. folderId	string ID of the folder that the Kubernetes cluster belongs to.
clusters[]. createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
clusters[]. name	string Name of the Kubernetes cluster.
clusters[]. description	string Description of the Kubernetes cluster. 0-256 characters long.
clusters[]. labels	object Resource labels as `key:value` pairs. Мaximum of 64 per resource.
clusters[]. 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.
clusters[]. health	string Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
clusters[]. networkId	string ID of the network the Kubernetes cluster belongs to.
clusters[]. master	object Properties of the master for the Kubernetes cluster.
clusters[]. master. version	string Version of Kubernetes components that runs on the master.
clusters[]. 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.
clusters[]. master. endpoints. internalV4Endpoint	string Internal endpoint that can be used to connect to the master from cloud networks.
clusters[]. master. endpoints. externalV4Endpoint	string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
clusters[]. master. masterAuth	object Master authentication parameters are used to establish trust between the master and a client.
clusters[]. master. masterAuth. clusterCaCertificate	string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
clusters[]. master. versionInfo	object
clusters[]. master. versionInfo. currentVersion	string Current kubernetes version, major.minor (e.g. 1.15).
clusters[]. 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.
clusters[]. master. versionInfo. newRevisionSummary	string Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
clusters[]. master. versionInfo. versionDeprecated	boolean (boolean) The current version is on the deprecation schedule, component (master or node group) should be upgraded.
clusters[]. master. maintenancePolicy	object
clusters[]. master. maintenancePolicy. autoUpgrade	boolean (boolean)
clusters[]. master. maintenancePolicy. maintenanceWindow	object
clusters[]. master. maintenancePolicy. maintenanceWindow. anytime	object `clusters[].master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow	object `clusters[].master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime	object Required. 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.
clusters[]. 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.
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
clusters[]. 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.
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. duration	string Acceptable values are 3600 seconds to 86400 seconds, inclusive.
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow	object `clusters[].master.maintenancePolicy.maintenanceWindow` includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]	object Required. The number of elements must be in the range 1-7.
clusters[]. 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.
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime	object Required. 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.
clusters[]. 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.
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
clusters[]. 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.
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. duration	string Acceptable values are 3600 seconds to 86400 seconds, inclusive.
clusters[]. master. zonalMaster	object Parameters of the availability zone for the master. `clusters[].master` includes only one of the fields `zonalMaster`, `regionalMaster`
clusters[]. master. zonalMaster. zoneId	string ID of the availability zone where the master resides.
clusters[]. master. zonalMaster. internalV4Address	string An IPv4 internal network address that is assigned to the master.
clusters[]. master. zonalMaster. externalV4Address	string An IPv4 external network address that is assigned to the master.
clusters[]. master. regionalMaster	object Parameters of the region for the master. `clusters[].master` includes only one of the fields `zonalMaster`, `regionalMaster`
clusters[]. master. regionalMaster. regionId	string ID of the region where the master resides.
clusters[]. master. regionalMaster. internalV4Address	string An IPv4 internal network address that is assigned to the master.
clusters[]. master. regionalMaster. externalV4Address	string An IPv4 external network address that is assigned to the master.
clusters[]. ipAllocationPolicy	object Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
clusters[]. 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.
clusters[]. 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.
clusters[]. serviceAccountId	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
clusters[]. 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.
clusters[]. releaseChannel	string
clusters[]. networkPolicy	object
clusters[]. networkPolicy. provider	string
clusters[]. gatewayIpv4Address	string Gateway IPv4 address. The maximum string length in characters is 15.
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 nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.