Method list

Retrieves the list of MySQL clusters that belong to the specified folder.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters

Query parameters

Parameter Description
folderId Required. ID of the folder to list MySQL 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 pageSize, 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 pageToken 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. Currently you can only use filtering with the Cluster.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Мust be 1-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$. 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
        },

        // `clusters[].config` includes only one of the fields `mysqlConfig_5_7`, `mysqlConfig_8_0`
        "mysqlConfig_5_7": {
          "effectiveConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          },
          "userConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          },
          "defaultConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          }
        },
        "mysqlConfig_8_0": {
          "effectiveConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          },
          "userConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          },
          "defaultConfig": {
            "innodbBufferPoolSize": "integer",
            "maxConnections": "integer",
            "longQueryTime": "number",
            "generalLog": true,
            "auditLog": true,
            "sqlMode": [
              "string"
            ],
            "maxAllowedPacket": "integer",
            "defaultAuthenticationPlugin": "string"
          }
        },
        // end of the list of possible fields`clusters[].config`

      },
      "networkId": "string",
      "health": "string",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

A MySQL cluster. For more information, see the documentation.

clusters[].
id
string

ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.

clusters[].
folderId
string

ID of the folder that the MySQL cluster belongs to.

clusters[].
createdAt
string (date-time)

String in RFC3339 text format.

clusters[].
name
string

Name of the MySQL 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 MySQL cluster. 0-256 characters long.

clusters[].
labels
object

Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.

clusters[].
environment
string

Deployment environment of the MySQL 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 MySQL 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 MySQL cluster.

clusters[].
config
object

Configuration of the MySQL cluster.

clusters[].
config.
version
string

Version of MySQL server software.

clusters[].
config.
resources
object
Resources allocated to MySQL 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-ssd — network SSD drive,
  • local-ssd — local SSD storage.
clusters[].
config.
backupWindowStart
object
Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

clusters[].
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.
mysqlConfig_5_7
object
Configuration of a MySQL 5.7 server.
clusters[].config includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig
object

Effective settings for a MySQL 5.7 cluster (a combination of settings defined in userConfig and [default_config]).

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_5_7.
effectiveConfig.
defaultAuthenticationPlugin
string
clusters[].
config.
mysqlConfig_5_7.
userConfig
object

User-defined settings for a MySQL 5.7 cluster.

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

clusters[].
config.
mysqlConfig_5_7.
userConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_5_7.
userConfig.
defaultAuthenticationPlugin
string
clusters[].
config.
mysqlConfig_5_7.
defaultConfig
object

Default configuration for a MySQL 5.7 cluster.

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_5_7.
defaultConfig.
defaultAuthenticationPlugin
string
clusters[].
config.
mysqlConfig_8_0
object
Configuration of a MySQL 8.0 server.
clusters[].config includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig
object

Effective settings for a MySQL 8.0 cluster (a combination of settings defined in userConfig and [default_config]).

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_8_0.
effectiveConfig.
defaultAuthenticationPlugin
string
clusters[].
config.
mysqlConfig_8_0.
userConfig
object

User-defined settings for a MySQL 8.0 cluster.

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

clusters[].
config.
mysqlConfig_8_0.
userConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_8_0.
userConfig.
defaultAuthenticationPlugin
string
clusters[].
config.
mysqlConfig_8_0.
defaultConfig
object

Default configuration for a MySQL 8.0 cluster.

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
innodbBufferPoolSize
integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
longQueryTime
number (double)

Time that it takes to process a query before it is considered slow.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

clusters[].
config.
mysqlConfig_8_0.
defaultConfig.
defaultAuthenticationPlugin
string
clusters[].
networkId
string

ID of the network that the cluster belongs to.

clusters[].
health
string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown ([Host.health] for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well ([Host.health] for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable ([Host.health] for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity ([Host.health] for at least one host 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.
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.