Managed Services for Kubernetes API, REST: Cluster.list
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 The maximum string length in characters is 100. |
filter | A filter expression that filters resources listed in the response. The expression must specify:
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": {
"locations": [
{
"zoneId": "string",
"subnetId": "string"
}
],
"etcdClusterSize": "string",
"version": "string",
"endpoints": {
"internalV4Endpoint": "string",
"externalV4Endpoint": "string",
"externalV6Endpoint": "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`
}
},
"securityGroupIds": [
"string"
],
"masterLogging": {
"enabled": true,
"auditEnabled": true,
"clusterAutoscalerEnabled": true,
"kubeApiserverEnabled": true,
"eventsEnabled": true,
// `clusters[].master.masterLogging` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`clusters[].master.masterLogging`
},
// `clusters[].master` includes only one of the fields `zonalMaster`, `regionalMaster`
"zonalMaster": {
"zoneId": "string",
"internalV4Address": "string",
"externalV4Address": "string"
},
"regionalMaster": {
"regionId": "string",
"internalV4Address": "string",
"externalV4Address": "string",
"externalV6Address": "string"
},
// end of the list of possible fields`clusters[].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",
"cilium": {
"routingMode": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
clusters[] | object List of 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. 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). |
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 |
clusters[]. status |
string Status of the Kubernetes cluster.
|
clusters[]. health |
string Health of the Kubernetes cluster.
|
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. locations[] |
object Locations specification for Kubernetes control-plane (master) instances. |
clusters[]. master. locations[]. zoneId |
string ID of the availability zone where the master resides. |
clusters[]. master. locations[]. subnetId |
string ID of the VPC network's subnet where the master resides. |
clusters[]. master. etcdClusterSize |
string (int64) Number of etcd nodes in 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. endpoints. externalV6Endpoint |
string External IPv6 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 Detailed information about the Kubernetes version that is running on the master. |
clusters[]. master. versionInfo. currentVersion |
string Current Kubernetes version, format: 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 platform specific components either on the master or nodes. |
clusters[]. master. versionInfo. newRevisionSummary |
string 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 Maintenance policy of the master. |
clusters[]. 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. |
clusters[]. 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. |
clusters[]. master. maintenancePolicy. maintenanceWindow. anytime |
object Updating the master at any time. clusters[].master.maintenancePolicy.maintenanceWindow includes only one of the fields anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
clusters[]. master. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow |
object Updating the master on any day during the specified time window. clusters[].master.maintenancePolicy.maintenanceWindow includes only one of the fields anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
clusters[]. 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. |
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 Window duration. Acceptable values are 3600 seconds to 86400 seconds, inclusive. |
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow |
object Updating the master on selected days during the specified time window. clusters[].master.maintenancePolicy.maintenanceWindow includes only one of the fields anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
clusters[]. 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. |
clusters[]. master. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. days[] |
string Required. Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
|
clusters[]. 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. |
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 Window duration. Acceptable values are 3600 seconds to 86400 seconds, inclusive. |
clusters[]. master. securityGroupIds[] |
string Master security groups. |
clusters[]. master. masterLogging |
object Cloud Logging for master components. |
clusters[]. master. masterLogging. enabled |
boolean (boolean) Identifies whether Cloud Logging is enabled for master components. |
clusters[]. master. masterLogging. auditEnabled |
boolean (boolean) Identifies whether Cloud Logging is enabled for audit logs. |
clusters[]. master. masterLogging. clusterAutoscalerEnabled |
boolean (boolean) Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
clusters[]. master. masterLogging. kubeApiserverEnabled |
boolean (boolean) Identifies whether Cloud Logging is enabled for kube-apiserver. |
clusters[]. master. masterLogging. eventsEnabled |
boolean (boolean) Identifies whether Cloud Logging is enabled for events. |
clusters[]. master. masterLogging. logGroupId |
string clusters[].master.masterLogging includes only one of the fields logGroupId , folderId ID of the log group where logs of master components should be stored. Value must match the regular expression |
clusters[]. master. masterLogging. folderId |
string clusters[].master.masterLogging includes only one of the fields logGroupId , folderId ID of the folder where logs should be stored (in default group). Value must match the regular expression |
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 IPv4 internal network address that is assigned to the master. |
clusters[]. master. zonalMaster. externalV4Address |
string 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 IPv4 internal network address that is assigned to the master. |
clusters[]. master. regionalMaster. externalV4Address |
string IPv4 external network address that is assigned to the master. |
clusters[]. master. regionalMaster. externalV6Address |
string IPv6 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. 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. |
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[]. ipAllocationPolicy. clusterIpv6CidrBlock |
string IPv6 range for allocating pod IP addresses. |
clusters[]. ipAllocationPolicy. serviceIpv6CidrBlock |
string IPv6 range for allocating Kubernetes service IP addresses |
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 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.
|
clusters[]. networkPolicy |
object |
clusters[]. networkPolicy. provider |
string |
clusters[]. kmsProvider |
object KMS provider configuration. |
clusters[]. kmsProvider. keyId |
string KMS key ID for secrets encryption. To obtain a KMS key ID use a list request. |
clusters[]. logGroupId |
string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
clusters[]. gatewayIpv4Address |
string Gateway IPv4 address. The maximum string length in characters is 15. |
clusters[]. cilium |
object |
clusters[]. cilium. routingMode |
string |
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 |