ClusterService

A set of methods for managing SQL Server clusters.

Call	Description
Get	Returns the specified SQL Server cluster.
List	Retrieves the list of SQL Server clusters that belong to the specified folder.
Create	Creates an SQL Server cluster in the specified folder.
Update	Modifies the specified SQL Server cluster.
Delete	Deletes the specified SQL Server cluster.
Start	Starts the specified SQL Server cluster.
Stop	Stops the specified SQL Server cluster.
Move	Moves the specified SQL Server cluster to the specified folder.
Backup	Creates a backup for the specified SQL Server cluster.
Restore	Creates a new SQL Server cluster using the specified backup.
ListLogs	Retrieves logs for the specified SQL Server cluster.
ListOperations	Retrieves the list of operations for the specified SQL Server cluster.
ListBackups	Retrieves the list of available backups for the specified SQL Server cluster.
ListHosts	Retrieves a list of hosts for the specified SQL Server cluster.

Calls ClusterService

Get

Returns the specified SQL Server cluster.
To get the list of available SQL Server clusters, make a List request.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to return. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

List

Retrieves the list of SQL Server clusters that belong to the specified folder.

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

Field	Description
folder_id	string Required. ID of the folder to list SQL Server clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
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. 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 to filter by. Currently you can only use filtering with the 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-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$. The maximum string length in characters is 1000.

ListClustersResponse

Field	Description
clusters[]	Cluster List of SQL Server clusters.
next_page_token	string Token that 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 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 SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Create

Creates an SQL Server 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 the SQL Server cluster in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Required. Name of the SQL Server cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the SQL Server cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. For example, "project": "mvp" or "source": "dictionary". 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]*.
environment	Cluster.Environment Deployment environment of the SQL Server cluster.
config_spec	ConfigSpec SQL Server and hosts configuration for the cluster.
database_specs[]	DatabaseSpec One or more configurations of databases to be created in the SQL Server cluster.
user_specs[]	UserSpec One or more configurations of database users to be created in the SQL Server cluster.
host_specs[]	HostSpec One or more configurations of hosts to be created in the SQL Server cluster.
network_id	string ID of the network to create the SQL Server cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string 2016sp2
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of an SQL Server cluster.
sqlserver_config_2016sp2std	config.SQLServerConfig2016sp2std Configuration for an SQL Server 2016 SP2 Standard edition cluster.
sqlserver_config_2016sp2ent	config.SQLServerConfig2016sp2ent Configuration for an SQL Server 2016 SP2 Enterprise edition cluster.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

DatabaseSpec

Field	Description
name	string Required. Name of the database. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

UserSpec

Field	Description
name	string Required. Name of the SQL Server user. The maximum string length in characters is 32. Value must match the regular expression [a-zA-Z0-9_]*.
password	string Required. Password of the SQL Server user. The string length in characters must be 8-128.
permissions[]	Permission Set of permissions to grant to the user.

Permission

Field	Description
database_name	string Name of the database the permission grants access to.
roles[]	enum Role Roles granted to the user within the database. The minimum number of elements is 1. DB_OWNER: Members of this fixed database role can perform all configuration and maintenance activities on the database, and can also drop the database in SQL Server. DB_SECURITYADMIN: Members of this fixed database role can modify role membership for custom roles only and manage permissions. They can potentially elevate their privileges and their actions should be monitored. DB_ACCESSADMIN: Members of this fixed database role can add or remove access to the database for Windows logins, Windows groups, and SQL Server logins. DB_BACKUPOPERATOR: Members of this fixed database role can back up the database. DB_DDLADMIN: Members of this fixed database role can run any Data Definition Language (DDL) command in a database. DB_DATAWRITER: Members of this fixed database role can add, delete, or change data in all user tables. DB_DATAREADER: Members of this fixed database role can read all data from all user tables. DB_DENYDATAWRITER: Members of this fixed database role cannot add, modify, or delete any data in the user tables within a database. Denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles. DB_DENYDATAREADER: Members of this fixed database role cannot read any data in the user tables within a database. Denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get the list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.

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 SQL Server cluster being created.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Update

Modifies the specified SQL Server 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 SQL Server cluster to update. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the SQL Server cluster should be updated.
description	string New description of the SQL Server cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the 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]*.
config_spec	ConfigSpec New configuration and resources for hosts in the SQL Server cluster.
name	string New name for the SQL Server cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string 2016sp2
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of an SQL Server cluster.
sqlserver_config_2016sp2std	config.SQLServerConfig2016sp2std Configuration for an SQL Server 2016 SP2 Standard edition cluster.
sqlserver_config_2016sp2ent	config.SQLServerConfig2016sp2ent Configuration for an SQL Server 2016 SP2 Enterprise edition cluster.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

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 SQL Server cluster being updated.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Delete

Deletes the specified SQL Server 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 SQL Server cluster to delete. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

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 SQL Server cluster being deleted.

Start

Starts the specified SQL Server cluster.

rpc Start (StartClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterMetadata

    Operation.response:Cluster

StartClusterRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to start. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

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 ID of the SQL Server cluster being started.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Stop

Stops the specified SQL Server cluster.

rpc Stop (StopClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopClusterMetadata

    Operation.response:Cluster

StopClusterRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to stop. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

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 ID of the SQL Server cluster being stopped.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Move

Moves the specified SQL Server cluster to the specified folder.

rpc Move (MoveClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveClusterMetadata

    Operation.response:Cluster

MoveClusterRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to move. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
destination_folder_id	string Required. ID of the destination folder. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.

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<MoveClusterMetadata> 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.

MoveClusterMetadata

Field	Description
cluster_id	string ID of the SQL Server cluster being moved.
source_folder_id	string ID of the source folder.
destination_folder_id	string ID of the destination folder.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Backup

Creates a backup for the specified SQL Server cluster.

rpc Backup (BackupClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:BackupClusterMetadata

    Operation.response:Cluster

BackupClusterRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to back up. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

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<BackupClusterMetadata> 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.

BackupClusterMetadata

Field	Description
cluster_id	string ID of the SQL Server cluster being backed up.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Restore

Creates a new SQL Server cluster using the specified backup.

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestoreClusterMetadata

    Operation.response:Cluster

RestoreClusterRequest

Field	Description
backup_id	string Required. ID of the backup to create a new cluster from. To get the backup ID, use a ClusterService.ListBackups request.
time	google.protobuf.Timestamp Required. Timestamp of the moment to which the SQL Server cluster should be restored.
name	string Required. Name of the new SQL Server cluster to be created from the backup. The name must be unique within the folder. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the new SQL Server cluster to be created from the backup. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the new SQL Server cluster to be created from the backup as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". 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]*.
environment	Cluster.Environment Deployment environment of the new SQL Server cluster to be created from the backup.
config_spec	ConfigSpec Configuration for the new SQL Server cluster to be created from the backup.
host_specs[]	HostSpec Configurations for SQL Server hosts that should be added to the cluster being created from the backup.
network_id	string ID of the network to create the SQL Server cluster in. The maximum string length in characters is 50.
folder_id	string ID of the folder to create the SQL Server cluster in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string 2016sp2
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of an SQL Server cluster.
sqlserver_config_2016sp2std	config.SQLServerConfig2016sp2std Configuration for an SQL Server 2016 SP2 Standard edition cluster.
sqlserver_config_2016sp2ent	config.SQLServerConfig2016sp2ent Configuration for an SQL Server 2016 SP2 Enterprise edition cluster.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get the list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.

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<RestoreClusterMetadata> 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.

RestoreClusterMetadata

Field	Description
cluster_id	string ID of the new SQL Server cluster being created from a backup.
backup_id	string ID of the backup being used for creating a cluster.

Cluster

Field	Description
id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
folder_id	string ID of the folder the SQL Server cluster belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the SQL Server cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.
description	string Description of the SQL Server cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the SQL Server cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the SQL Server cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SQL Server cluster.
config	ClusterConfig Configuration of the SQL Server cluster.
network_id	string ID of the network the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD). DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SQL Server cluster.

ClusterConfig

Field	Description
version	string Version of the SQL Server.
sqlserver_config	oneof: sqlserver_config_2016sp2std or sqlserver_config_2016sp2ent Configuration of the SQL Server instances in the cluster.
sqlserver_config_2016sp2std	config.SQLServerConfigSet2016sp2std Configuration of the SQL Server 2016sp2 standard edition instance.
sqlserver_config_2016sp2ent	config.SQLServerConfigSet2016sp2ent Configuration of the SQL Server 2016sp2 enterprise edition instance.
resources	Resources Resources allocated to SQL Server hosts.
backup_window_start	google.type.TimeOfDay Start time for the daily backup in UTC timezone

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

ListLogs

Retrieves logs for the specified SQL Server cluster.
For more information about logs, see the Logs section in the documentation.

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to request logs for. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
column_filter[]	string Columns from the logs table to request. If no columns are specified, entire log records are returned.
service_type	enum ServiceType Type of the service to request logs about. SQLSERVER_ERROR: SQL Server error log. SQLSERVER_APPLICATION: SQL Server application log.
from_time	google.protobuf.Timestamp Start timestamp for the logs request.
to_time	google.protobuf.Timestamp End timestamp for the logs 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 ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
always_next_page_token	bool Always return next_page_token, even if current page is empty.
filter	string The field name to filter by. Currently filtering can be applied to the LogRecord.logs.message.hostname field. A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Must be 1-63 characters long and match the regular expression ^[a-z0-9.-]{1,61}$. The maximum string length in characters is 1000.

ListClusterLogsResponse

Field	Description
logs[]	LogRecord Requested log records.
next_page_token	string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.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.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp.
message	map<string,string> Contents of the log record.

ListOperations

Retrieves the list of operations for the specified SQL Server cluster.

rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

ListClusterOperationsRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to list operations for. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
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 ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. 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.

ListClusterOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified SQL Server cluster.
next_page_token	string Token that 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.

ListBackups

Retrieves the list of available backups for the specified SQL Server cluster.

rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

ListClusterBackupsRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
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 ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterBackupsResponse

Field	Description
backups[]	Backup List of SQL Server backups.
next_page_token	string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.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.

Backup

Field	Description
id	string ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp (i.e. when the backup operation was completed).
source_cluster_id	string ID of the SQL Server cluster that the backup was created for.
started_at	google.protobuf.Timestamp Time when the backup operation was started.

ListHosts

Retrieves a list of hosts for the specified SQL Server cluster.

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the SQL Server cluster. To get the SQL Server cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
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 ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterHostsResponse

Field	Description
hosts[]	Host List of SQL Server hosts.
next_page_token	string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.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.

Host

Field	Description
name	string Name of the SQL Server host. The host name is assigned by Managed Service for SQL Server at creation time, and cannot be changed. 1-63 characters long. The name is unique across all existing database hosts in Yandex.Cloud, as it defines the FQDN of the host.
cluster_id	string ID of the SQL Server host. The ID is assigned by Managed Service for SQL Server at creation time.
zone_id	string ID of the availability zone where the SQL Server host resides.
resources	Resources Resources allocated to the host.
role	enum Role Role of the host in the cluster. ROLE_UNKNOWN: Role of the host in the cluster is unknown. MASTER: Host is the master SQL Server instance in the cluster. REPLICA: Host is a replica SQL Server instance in the cluster.
health	enum Health Status code of the aggregated health of the host. HEALTH_UNKNOWN: Health of the host is unknown. ALIVE: The host is performing all its functions normally. DEAD: The host is inoperable, and cannot perform any of its essential functions. DEGRADED: The host is degraded, and can perform only some of its essential functions.
services[]	Service Services provided by the host.
subnet_id	string ID of the subnet that the host belongs to.
assign_public_ip	bool Flag showing public IP assignment status to this host.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Service

Field	Description
type	enum Type Type of the service provided by the host. SQLSERVER: SQL Server service
health	enum Health Status code of server availability. HEALTH_UNKNOWN: Health of the server is unknown. ALIVE: The server is working normally. DEAD: The server is dead or unresponsive.