Method list

Статья создана

HTTP request
Query parameters
Response

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

HTTP request

GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1/clusters

Query parameters

Parameter	Description
folderId	Required. ID of the folder to list SQL Server clusters in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize	The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken	Page token. To get the next page of results, set `page_token` to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter	A filter expression that filters resources listed in the response. The expression must specify: 1. The field name to filter by. Currently you can only use filtering with the Cluster.name field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 1-63 characters long and match the regular expression `[a-zA-Z0-9_-]+`. Example of a filter: `name NOT IN 'test,beta'`. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "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
        },

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

      },
      "networkId": "string",
      "health": "string",
      "status": "string",
      "securityGroupIds": [
        "string"
      ],
      "deletionProtection": true,
      "sqlcollation": "string",
      "hostGroupIds": [
        "string"
      ],
      "serviceAccountId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field	Description
clusters[]	object An SQL Server cluster. For more information, see the Concepts section of the documentation.
clusters[]. id	string ID of the SQL Server cluster. This ID is assigned by Managed Service for SQL Server at creation time.
clusters[]. folderId	string ID of the folder the SQL Server cluster belongs to.
clusters[]. createdAt	string (date-time) String in RFC3339 text format.
clusters[]. 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.
clusters[]. description	string Description of the SQL Server cluster. 0-256 characters long.
clusters[]. labels	object Custom labels for the SQL Server cluster as `key:value` pairs. Maximum 64 per resource.
clusters[]. environment	string 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.
clusters[]. monitoring[]	object Description of monitoring systems relevant to the SQL Server cluster.
clusters[]. monitoring[]. name	string Name of the monitoring system.
clusters[]. monitoring[]. description	string Description of the monitoring system.
clusters[]. monitoring[]. link	string Link to the monitoring system charts for the SQL Server cluster.
clusters[]. config	object Configuration of the SQL Server cluster.
clusters[]. config. version	string Version of the SQL Server.
clusters[]. config. resources	object Resources allocated to SQL Server hosts.
clusters[]. 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.
clusters[]. config. resources. diskSize	string (int64) Volume of the storage available to a host.
clusters[]. config. resources. diskTypeId	string Type of the storage environment for the host. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. backupWindowStart. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
clusters[]. 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.
clusters[]. config. backupWindowStart. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
clusters[]. config. access	object Access policy to DB
clusters[]. config. access. dataLens	boolean (boolean) Allow access for DataLens
clusters[]. config. access. webSql	boolean (boolean) Allow access for Web SQL.
clusters[]. config. sqlserverConfig_2016Sp2Std	object Configuration of the SQL Server 2016sp2 standard edition instance. `clusters[].config` includes only one of the fields `sqlserverConfig_2016Sp2Std`, `sqlserverConfig_2016Sp2Ent`
clusters[]. config. sqlserverConfig_2016Sp2Std. effectiveConfig	object Effective settings for an SQL Server 2016 SP2 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Std. effectiveConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Std. userConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Std. defaultConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Ent	object Configuration of the SQL Server 2016sp2 enterprise edition instance. `clusters[].config` includes only one of the fields `sqlserverConfig_2016Sp2Std`, `sqlserverConfig_2016Sp2Ent`
clusters[]. config. sqlserverConfig_2016Sp2Ent. effectiveConfig	object Effective settings for an SQL Server 2016 SP2 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Ent. effectiveConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Ent. userConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. 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.
clusters[]. config. sqlserverConfig_2016Sp2Ent. defaultConfig. auditLevel	integer (int64) Describes how to configure login auditing to monitor SQL Server Database Engine login activity. Possible values: 0 - do not log login attempts, 1 - log only failed login attempts, 2 - log only successful login attempts (not recommended), 3 - log all login attempts (not recommended). See in-depth description in SQL Server documentation. Acceptable values are 0 to 3, inclusive.
clusters[]. 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.
clusters[]. 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.
clusters[]. networkId	string ID of the network the cluster belongs to.
clusters[]. health	string Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (`health` of all hosts in the cluster is `UNKNOWN`). ALIVE: Cluster is alive and well (`health` of all hosts in the cluster is `ALIVE`). DEAD: Cluster is inoperable (`health` of all hosts in the cluster is `DEAD`). DEGRADED: Cluster is in degraded state (`health` of at least one of the hosts in the cluster is not `ALIVE`).
clusters[]. status	string 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.
clusters[]. securityGroupIds[]	string User security groups
clusters[]. deletionProtection	boolean (boolean) Deletion Protection inhibits deletion of the cluster
clusters[]. sqlcollation	string SQL Server Collation
clusters[]. hostGroupIds[]	string Host groups hosting VMs of the cluster.
clusters[]. serviceAccountId	string ID of the service account used for access to Yandex Object Storage.
nextPageToken	string Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the `next_page_token` as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results.

Method list

HTTP request

Query parameters

Response

Была ли статья полезна?