ClusterService

A set of methods for managing Kubernetes cluster.

Call	Description
Get	Returns the specified Kubernetes cluster.
List	Retrieves the list of Kubernetes cluster in the specified folder.
Create	Creates a Kubernetes cluster in the specified folder.
Update	Updates the specified Kubernetes cluster.
Delete	Deletes the specified Kubernetes cluster.
Stop
Start
ListNodeGroups	Lists nodegroup for the specified Kubernetes cluster.
ListOperations	Lists operations for the specified Kubernetes cluster.

Calls ClusterService

Get

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

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field	Description
cluster_id	string Required. ID of the Kubernetes cluster to return.

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

Master

Field	Description
master_type	oneof: zonal_master or regional_master
zonal_master	ZonalMaster Parameters of the availability zone for the master.
regional_master	RegionalMaster Parameters of the region for the master.
version	string Version of Kubernetes components that runs on the master.
endpoints	MasterEndpoints 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_auth	MasterAuth Master authentication parameters are used to establish trust between the master and a client.
version_info	VersionInfo
maintenance_policy	MasterMaintenancePolicy

ZonalMaster

Field	Description
zone_id	string ID of the availability zone where the master resides.
internal_v4_address	string An IPv4 internal network address that is assigned to the master.
external_v4_address	string An IPv4 external network address that is assigned to the master.

RegionalMaster

Field	Description
region_id	string ID of the region where the master resides.
internal_v4_address	string An IPv4 internal network address that is assigned to the master.
external_v4_address	string An IPv4 external network address that is assigned to the master.

MasterEndpoints

Field	Description
internal_v4_endpoint	string Internal endpoint that can be used to connect to the master from cloud networks.
external_v4_endpoint	string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).

MasterAuth

Field	Description
cluster_ca_certificate	string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.

VersionInfo

Field	Description
current_version	string Current kubernetes version, major.minor (e.g. 1.15).
new_revision_available	bool 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.
new_revision_summary	string Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
version_deprecated	bool The current version is on the deprecation schedule, component (master or node group) should be upgraded.

MasterMaintenancePolicy

Field	Description
auto_upgrade	bool
maintenance_window	MaintenanceWindow

MaintenanceWindow

Field	Description
policy	oneof: anytime, daily_maintenance_window or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
daily_maintenance_window	DailyMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

DailyMaintenanceWindow

Field	Description
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

WeeklyMaintenanceWindow

Field	Description
days_of_week[]	DaysOfWeekMaintenanceWindow The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	google.type.DayOfWeek The number of elements must be in the range 1-7.
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

IPAllocationPolicy

Field	Description
cluster_ipv4_cidr_block	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.
service_ipv4_cidr_block	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.

List

Retrieves the list of Kubernetes cluster in the specified folder.

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

Field	Description
folder_id	string Required. ID of the folder to list Kubernetes cluster in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClustersResponse.next_page_token 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.
page_token	string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string The field name. Currently you can use filtering only on Cluster.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 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.

ListClustersResponse

Field	Description
clusters[]	Cluster List of Kubernetes cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

Master

Field	Description
master_type	oneof: zonal_master or regional_master
zonal_master	ZonalMaster Parameters of the availability zone for the master.
regional_master	RegionalMaster Parameters of the region for the master.
version	string Version of Kubernetes components that runs on the master.
endpoints	MasterEndpoints 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_auth	MasterAuth Master authentication parameters are used to establish trust between the master and a client.
version_info	VersionInfo
maintenance_policy	MasterMaintenancePolicy

ZonalMaster

Field	Description
zone_id	string ID of the availability zone where the master resides.
internal_v4_address	string An IPv4 internal network address that is assigned to the master.
external_v4_address	string An IPv4 external network address that is assigned to the master.

RegionalMaster

Field	Description
region_id	string ID of the region where the master resides.
internal_v4_address	string An IPv4 internal network address that is assigned to the master.
external_v4_address	string An IPv4 external network address that is assigned to the master.

MasterEndpoints

Field	Description
internal_v4_endpoint	string Internal endpoint that can be used to connect to the master from cloud networks.
external_v4_endpoint	string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).

MasterAuth

Field	Description
cluster_ca_certificate	string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.

VersionInfo

Field	Description
current_version	string Current kubernetes version, major.minor (e.g. 1.15).
new_revision_available	bool 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.
new_revision_summary	string Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
version_deprecated	bool The current version is on the deprecation schedule, component (master or node group) should be upgraded.

MasterMaintenancePolicy

Field	Description
auto_upgrade	bool
maintenance_window	MaintenanceWindow

MaintenanceWindow

Field	Description
policy	oneof: anytime, daily_maintenance_window or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
daily_maintenance_window	DailyMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

DailyMaintenanceWindow

Field	Description
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

WeeklyMaintenanceWindow

Field	Description
days_of_week[]	DaysOfWeekMaintenanceWindow The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	google.type.DayOfWeek The number of elements must be in the range 1-7.
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

IPAllocationPolicy

Field	Description
cluster_ipv4_cidr_block	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.
service_ipv4_cidr_block	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.

Create

Creates a Kubernetes cluster in the specified folder.

rpc Create (CreateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateClusterMetadata

    Operation.response:Cluster

CreateClusterRequest

Field	Description
folder_id	string Required. ID of the folder to create a Kubernetes cluster in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the Kubernetes cluster. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description	string Description of the Kubernetes cluster. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
network_id	string Required. ID of the network.
master_spec	MasterSpec Required. IP allocation policy of the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy IP allocation policy of the Kubernetes cluster.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address.
service_account_id	string Required. Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
node_service_account_id	string Required. Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
release_channel	enum ReleaseChannel

MasterSpec

Field	Description
master_type	oneof: zonal_master_spec or regional_master_spec
zonal_master_spec	ZonalMasterSpec Specification of the master availability zone.
regional_master_spec	RegionalMasterSpec
version	string
maintenance_policy	MasterMaintenancePolicy

ZonalMasterSpec

Field	Description
zone_id	string Required. ID of the availability zone.
internal_v4_address_spec	InternalAddressSpec Specification of parameters for internal IPv4 networking.
external_v4_address_spec	ExternalAddressSpec Specification of parameters for external IPv4 networking.

InternalAddressSpec

Field	Description
subnet_id	string ID of the subnet. If no ID is specified, and there only one subnet in specified zone, an address in this subnet will be allocated.

ExternalAddressSpec

RegionalMasterSpec

Field	Description
region_id	string Required.
locations[]	MasterLocation
external_v4_address_spec	ExternalAddressSpec Specify to allocate a static public IP for the master

MasterLocation

Field	Description
zone_id	string Required.
internal_v4_address_spec	InternalAddressSpec If not specified and there is a single subnet in specified zone, address in this subnet will be allocated.

InternalAddressSpec

Field	Description
subnet_id	string ID of the subnet. If no ID is specified, and there only one subnet in specified zone, an address in this subnet will be allocated.

ExternalAddressSpec

MasterMaintenancePolicy

Field	Description
auto_upgrade	bool
maintenance_window	MaintenanceWindow

MaintenanceWindow

Field	Description
policy	oneof: anytime, daily_maintenance_window or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
daily_maintenance_window	DailyMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

DailyMaintenanceWindow

Field	Description
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

WeeklyMaintenanceWindow

Field	Description
days_of_week[]	DaysOfWeekMaintenanceWindow The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	google.type.DayOfWeek The number of elements must be in the range 1-7.
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

IPAllocationPolicy

Field	Description
cluster_ipv4_cidr_block	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.
service_ipv4_cidr_block	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.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

CreateClusterMetadata

Field	Description
cluster_id	string ID of the Kubernetes cluster that is being created.

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

Update

Updates the specified Kubernetes cluster.

rpc Update (UpdateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterMetadata

    Operation.response:Cluster

UpdateClusterRequest

Field	Description
cluster_id	string Required. ID of the Kubernetes cluster to update. To get the Kubernetes cluster ID use a ClusterService.List request.
update_mask	google.protobuf.FieldMask
name	string Name of the Kubernetes cluster. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description	string Description of the Kubernetes cluster. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string The maximum string length in characters is 15.
master_spec	MasterUpdateSpec
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
node_service_account_id	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.

MasterUpdateSpec

Field	Description
version	UpdateVersionSpec
maintenance_policy	MasterMaintenancePolicy

UpdateVersionSpec

Field	Description
specifier	oneof: version or latest_revision
version	string Request update to a newer version of kubernetes (1.x -> 1.y).
latest_revision	bool Request update to the latest revision for the current version.

MasterMaintenancePolicy

Field	Description
auto_upgrade	bool
maintenance_window	MaintenanceWindow

MaintenanceWindow

Field	Description
policy	oneof: anytime, daily_maintenance_window or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
daily_maintenance_window	DailyMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

DailyMaintenanceWindow

Field	Description
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

WeeklyMaintenanceWindow

Field	Description
days_of_week[]	DaysOfWeekMaintenanceWindow The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	google.type.DayOfWeek The number of elements must be in the range 1-7.
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

UpdateClusterMetadata

Field	Description
cluster_id	string ID of the Kubernetes cluster that is being updated.

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

Delete

Deletes the specified Kubernetes cluster.

rpc Delete (DeleteClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterRequest

Field	Description
cluster_id	string Required. ID of the Kubernetes cluster to delete. To get Kubernetes cluster ID use a ClusterService.List request.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterMetadata

Field	Description
cluster_id	string ID of the Kubernetes cluster that is being deleted.

Stop

rpc Stop (StopClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopClusterMetadata

    Operation.response:Cluster

StopClusterRequest

Field	Description
cluster_id	string Required.
service_account_id	string

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<StopClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StopClusterMetadata

Field	Description
cluster_id	string

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

Start

rpc Start (StartClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterMetadata

    Operation.response:Cluster

StartClusterRequest

Field	Description
cluster_id	string Required.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<StartClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterMetadata

Field	Description
cluster_id	string

Cluster

Field	Description
id	string ID of the Kubernetes cluster.
folder_id	string ID of the folder that the Kubernetes cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status 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	enum Health Health of the Kubernetes cluster. HEALTHY: Kubernetes cluster is alive and well. UNHEALTHY: Kubernetes cluster is inoperable.
network_id	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ip_allocation_policy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
internet_gateway	oneof: gateway_ipv4_address
gateway_ipv4_address	string Gateway IPv4 address. The maximum string length in characters is 15.
service_account_id	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
node_service_account_id	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.
release_channel	enum ReleaseChannel

ListNodeGroups

Lists nodegroup for the specified Kubernetes cluster.

rpc ListNodeGroups (ListClusterNodeGroupsRequest) returns (ListClusterNodeGroupsResponse)

ListClusterNodeGroupsRequest

Field	Description
cluster_id	string Required. ID of the Kubernetes cluster to list node groups in. To get the Kubernetes cluster ID use a ClusterService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterNodeGroupsResponse.next_page_token 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.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterNodeGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. Currently you can use filtering only on Cluster.name field. The maximum string length in characters is 1000.

ListClusterNodeGroupsResponse

Field	Description
node_groups[]	NodeGroup List of node groups for the specified Kubernetes cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterNodeGroupsRequest.page_size, use the next_page_token as the value for the ListClusterNodeGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

NodeGroup

Field	Description
id	string ID of the node group.
cluster_id	string ID of the cluster that the node group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the node group. The name is unique within the folder.
description	string Description of the node group. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
status	enum Status Status of the node group. PROVISIONING: Node group is waiting for resources to be allocated. RUNNING: Node group is running. RECONCILING: Node group is waiting for some work to be done, such as upgrading node software. STOPPING: Node group is being stopped. STOPPED: Node group stopped. DELETING: Node group is being deleted. STARTING: Node group is being started.
node_template	NodeTemplate Node template that specifies parameters of the compute instances for the node group.
scale_policy	ScalePolicy Scale policy of the node group. For more information, see Scaling policy.
allocation_policy	NodeGroupAllocationPolicy Allocation policy by which resources for node group are allocated to zones and regions.
instance_group_id	string ID of the managed instance group associated with this node group.
node_version	string Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
version_info	VersionInfo
maintenance_policy	NodeGroupMaintenancePolicy

NodeTemplate

Field	Description
platform_id	string ID of the hardware platform configuration for the node.
resources_spec	ResourcesSpec Computing resources of the node such as the amount of memory and number of cores.
boot_disk_spec	DiskSpec Specification for the boot disk that will be attached to the node. The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata.
metadata	map<string,string> No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
v4_address_spec	NodeAddressSpec Specification for the create network interfaces for the node group compute instances.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.

ResourcesSpec

Field	Description
memory	int64 Amount of memory available to the node, specified in bytes. Acceptable values are 0 to 274877906944, inclusive.
cores	int64 Number of cores available to the node. Value must be equal to 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
core_fraction	int64 Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100.

DiskSpec

Field	Description
disk_type_id	string ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
disk_size	int64 Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

NodeAddressSpec

Field	Description
one_to_one_nat_spec	OneToOneNatSpec One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

OneToOneNatSpec

Field	Description
ip_version	enum IpVersion IP version for the public IP address. IPV4: IPv4 address, for example 192.168.0.0. IPV6: IPv6 address, not available yet.

SchedulingPolicy

Field	Description
preemptible	bool True for preemptible compute instances. Default value is false. Preemptible compute instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.

ScalePolicy

Field	Description
scale_type	oneof: fixed_scale or auto_scale
fixed_scale	FixedScale Fixed scale policy of the node group.
auto_scale	AutoScale Auto scale policy of the node group.

FixedScale

Field	Description
size	int64 Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

AutoScale

Field	Description
min_size	int64 Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
max_size	int64 Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
initial_size	int64 Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

NodeGroupAllocationPolicy

Field	Description
locations[]	NodeGroupLocation List of locations where resources for the node group will be allocated.

NodeGroupLocation

Field	Description
zone_id	string Required. ID of the availability zone where the nodes may reside.
subnet_id	string ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

VersionInfo

Field	Description
current_version	string Current kubernetes version, major.minor (e.g. 1.15).
new_revision_available	bool 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.
new_revision_summary	string Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
version_deprecated	bool The current version is on the deprecation schedule, component (master or node group) should be upgraded.

NodeGroupMaintenancePolicy

Field	Description
auto_upgrade	bool
auto_repair	bool
maintenance_window	MaintenanceWindow

MaintenanceWindow

Field	Description
policy	oneof: anytime, daily_maintenance_window or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
daily_maintenance_window	DailyMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

DailyMaintenanceWindow

Field	Description
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

WeeklyMaintenanceWindow

Field	Description
days_of_week[]	DaysOfWeekMaintenanceWindow The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	google.type.DayOfWeek The number of elements must be in the range 1-7.
start_time	google.type.TimeOfDay Required.
duration	google.protobuf.Duration Acceptable values are 1h to 24h, inclusive.

ListOperations

Lists operations for the specified Kubernetes cluster.

rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

ListClusterOperationsRequest

Field	Description
cluster_id	string Required. ID of the Kubernetes cluster to list operations for.
page_size	int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListClusterOperationsResponse.next_page_token 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.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. Currently you can use filtering only on Cluster.name field. The maximum string length in characters is 1000.

ListClusterOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified Kubernetes cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.