Method get
Returns the specified SQL Server cluster.
To get the list of available SQL Server clusters, make a list request.
HTTP request
GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the SQL Server cluster to return. To get the cluster ID, use a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": true,
"webSql": true
},
// `config` includes only one of the fields `sqlserverConfig_2016Sp2Std`, `sqlserverConfig_2016Sp2Ent`
"sqlserverConfig_2016Sp2Std": {
"effectiveConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
},
"userConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
},
"defaultConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
}
},
"sqlserverConfig_2016Sp2Ent": {
"effectiveConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
},
"userConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
},
"defaultConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"auditLevel": "integer",
"fillFactorPercent": "integer",
"optimizeForAdHocWorkloads": true
}
},
// end of the list of possible fields`config`
},
"networkId": "string",
"health": "string",
"status": "string",
"securityGroupIds": [
"string"
],
"deletionProtection": true,
"sqlcollation": "string",
"hostGroupIds": [
"string"
],
"serviceAccountId": "string"
}
An SQL Server cluster.
For more information, see the Concepts section of the documentation.
Field | Description |
---|---|
id | string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time. |
folderId | string ID of the folder the SQL Server cluster belongs to. |
createdAt | string (date-time) String in RFC3339 text format. |
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 | object Custom labels for the SQL Server cluster as |
environment | string Deployment environment of the SQL Server cluster.
|
monitoring[] | object Description of monitoring systems relevant to the SQL Server cluster. |
monitoring[]. name |
string Name of the monitoring system. |
monitoring[]. description |
string Description of the monitoring system. |
monitoring[]. link |
string Link to the monitoring system charts for the SQL Server cluster. |
config | object Configuration of the SQL Server cluster. |
config. version |
string Version of the SQL Server. |
config. resources |
object Resources allocated to SQL Server hosts. |
config. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
config. resources. diskSize |
string (int64) Volume of the storage available to a host. |
config. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
config. backupWindowStart |
object Start time for the daily backup in UTC timezone Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. |
config. backupWindowStart. hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
config. backupWindowStart. minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
config. backupWindowStart. seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
config. backupWindowStart. nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
config. access |
object Access policy to DB |
config. access. dataLens |
boolean (boolean) Allow access for DataLens |
config. access. webSql |
boolean (boolean) Allow access for Web SQL. |
config. sqlserverConfig_2016Sp2Std |
object Configuration of the SQL Server 2016sp2 standard edition instance. config includes only one of the fields sqlserverConfig_2016Sp2Std , sqlserverConfig_2016Sp2Ent |
config. sqlserverConfig_2016Sp2Std. effectiveConfig |
object Effective settings for an SQL Server 2016 SP2 cluster (a combination of settings defined in SQL Server 2016 SP2 Standard edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Std. effectiveConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Std. effectiveConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Std. effectiveConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Std. effectiveConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Std. effectiveConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
config. sqlserverConfig_2016Sp2Std. userConfig |
object User-defined settings for an SQL Server 2016 SP2 cluster. SQL Server 2016 SP2 Standard edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Std. userConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Std. userConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Std. userConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Std. userConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Std. userConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
config. sqlserverConfig_2016Sp2Std. defaultConfig |
object Default configuration for an SQL Server 2016 SP2 cluster. SQL Server 2016 SP2 Standard edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Std. defaultConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Std. defaultConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Std. defaultConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Std. defaultConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Std. defaultConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
config. sqlserverConfig_2016Sp2Ent |
object Configuration of the SQL Server 2016sp2 enterprise edition instance. config includes only one of the fields sqlserverConfig_2016Sp2Std , sqlserverConfig_2016Sp2Ent |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig |
object Effective settings for an SQL Server 2016 SP2 cluster (a combination of settings defined in SQL Server 2016 SP2 Enterprise edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Ent. effectiveConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
config. sqlserverConfig_2016Sp2Ent. userConfig |
object User-defined settings for an SQL Server 2016 SP2 cluster. SQL Server 2016 SP2 Enterprise edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Ent. userConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Ent. userConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Ent. userConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Ent. userConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Ent. userConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig |
object Default configuration for an SQL Server 2016 SP2 cluster. SQL Server 2016 SP2 Enterprise edition supported configuration options are listed here. Detailed description for each set of options is available in SQL Server documentation. Any options that are not listed here are not supported. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig. maxDegreeOfParallelism |
integer (int64) Limits the number of processors to use in parallel plan execution per task. See in-depth description in SQL Server documentation. Acceptable values are 1 to 99, inclusive. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig. costThresholdForParallelism |
integer (int64) Specifies the threshold at which SQL Server creates and runs parallel plans for queries. SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option. See in-depth description in SQL Server documentation. Acceptable values are 5 to 32767, inclusive. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig. auditLevel |
integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values:
See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig. fillFactorPercent |
integer (int64) Manages the fill factor server configuration option. When an index is created or rebuilt the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth. Values 0 and 100 mean full page usage (no space reserved). See in-depth description in SQL Server documentation. Acceptable values are 0 to 100, inclusive. |
config. sqlserverConfig_2016Sp2Ent. defaultConfig. optimizeForAdHocWorkloads |
boolean (boolean) Determines whether plans should be cached only after second execution. Allows to avoid SQL cache bloat because of single-use plans. See in-depth description in SQL Server documentation. |
networkId | string ID of the network the cluster belongs to. |
health | string Aggregated cluster health.
|
status | string Current state of the cluster.
|
securityGroupIds[] | string User security groups |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
sqlcollation | string SQL Server Collation |
hostGroupIds[] | string Host groups hosting VMs of the cluster. |
serviceAccountId | string ID of the service account used for access to Yandex Object Storage. |