Подключиться
Yandex Managed Service for Redis

ClusterService

Методы для управления кластерами Redis.

Вызов Описание
Get Возвращает указанный кластер Redis.
List Возвращает список кластеров Redis, принадлежащих указанному каталогу.
Create Создает кластер Redis в указанном каталоге.
Update Изменяет указанный кластер Redis.
Delete Удаляет указанный кластер Redis.
Start Запускает указанный кластер Redis.
Stop Останавливает указанный кластер Redis.
Move Перемещает кластер Redis в указанный каталог.
Backup Создает резервную копию для указанного кластера Redis.
Restore Создает новый кластер Redis с использованием указанной резервной копии.
StartFailover Запускает ручное переключение мастера для указанного кластера Redis.
ListLogs Получает логи для указанного кластера Redis.
ListOperations Возвращает список операций для указанного кластера.
ListBackups Получает список доступных резервных копий для указанного кластера Redis.
ListHosts Получает список хостов для указанного кластера.
AddHosts Создает новые хосты для кластера.
DeleteHosts Удаляет указанные хосты кластера.
GetShard Возвращает указанный шард.
ListShards Получает список шардов.
AddShard Создает новый шард.
DeleteShard Удаляет указанный шард.
Rebalance Перебалансирует кластер.

Вызовы ClusterService

Get

Возвращает указанный кластер Redis.
Чтобы получить список доступных резервных копий Redis, используйте запрос List.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор возвращаемого кластера Redis. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

Cluster

Поле Описание
id string
Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
folder_id string
Идентификатор каталога, которому принадлежит кластер Redis.
created_at google.protobuf.Timestamp
Время создания в формате RFC3339 .
name string
Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
description string
Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
environment enum Environment
Среда развертывания кластера Redis.
  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
    monitoring[] Monitoring
    Описание систем мониторинга, относящихся к данному кластеру Redis.
    config ClusterConfig
    Конфигурация кластера Redis.
    network_id string
    health enum Health
    Агрегированная работоспособность кластера.
    • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
    • ALIVE: Кластер жив и здоров (все хосты живы)
    • DEAD: Кластер не работает и не может выполнять свои основные функции
    • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
      status enum Status
      Состояние кластера.
      • STATUS_UNKNOWN: Состояние кластера неизвестно
      • CREATING: Кластер создается
      • RUNNING: Кластер работает нормально
      • ERROR: Кластер отказал.
      • UPDATING: Кластер изменяется.
      • STOPPING: Кластер останавливается.
      • STOPPED: Кластер остановлен.
      • STARTING: Кластер запускается.
        sharded bool
        Включение/выключение режима Redis Cluster.

        Monitoring

        Поле Описание
        name string
        Название системы мониторинга.
        description string
        Описание системы мониторинга.
        link string
        Ссылка на графики системы мониторинга для кластера Redis.

        ClusterConfig

        Поле Описание
        version string
        Версия серверного программного обеспечения Redis.
        redis_config oneof: redis_config_5_0
        Конфигурация для серверов Redis в кластере.
          redis_config_5_0 config.RedisConfigSet5_0
        Конфигурация сервера Redis 5.0.
        resources Resources
        Ресурсы, выделенные хостам Redis.
        backup_window_start google.type.TimeOfDay
        Время запуска ежедневного резервного копирования, в часовом поясе UTC.
        access Access
        Политика доступа к БД

        Resources

        Поле Описание
        resource_preset_id string
        Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
        disk_size int64
        Объем хранилища, доступного хосту, в байтах.

        Access

        Поле Описание
        data_lens bool
        Разрешить доступ для DataLens

        List

        Возвращает список кластеров Redis, принадлежащих указанному каталогу.

        rpc List (ListClustersRequest) returns (ListClustersResponse)

        ListClustersRequest

        Поле Описание
        folder_id string
        Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров Redis. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
        page_size int64
        Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
        page_token string
        Токен страницы. Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
        filter string
        1. Имя поля. В настоящее время фильтрацию можно использовать только с полем Cluster.name.
        2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
        3. Значение. Должен содержать от 3 до 63 символов и соответствовать регулярному выражению ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$.
        Максимальная длина строки в символах — 1000.

        ListClustersResponse

        Поле Описание
        clusters[] Cluster
        Список кластеров Redis.
        next_page_token string
        Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

        Cluster

        Поле Описание
        id string
        Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
        folder_id string
        Идентификатор каталога, которому принадлежит кластер Redis.
        created_at google.protobuf.Timestamp
        Время создания в формате RFC3339 .
        name string
        Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
        description string
        Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
        labels map<string,string>
        Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
        environment enum Environment
        Среда развертывания кластера Redis.
        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
          monitoring[] Monitoring
          Описание систем мониторинга, относящихся к данному кластеру Redis.
          config ClusterConfig
          Конфигурация кластера Redis.
          network_id string
          health enum Health
          Агрегированная работоспособность кластера.
          • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
          • ALIVE: Кластер жив и здоров (все хосты живы)
          • DEAD: Кластер не работает и не может выполнять свои основные функции
          • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
            status enum Status
            Состояние кластера.
            • STATUS_UNKNOWN: Состояние кластера неизвестно
            • CREATING: Кластер создается
            • RUNNING: Кластер работает нормально
            • ERROR: Кластер отказал.
            • UPDATING: Кластер изменяется.
            • STOPPING: Кластер останавливается.
            • STOPPED: Кластер остановлен.
            • STARTING: Кластер запускается.
              sharded bool
              Включение/выключение режима Redis Cluster.

              Monitoring

              Поле Описание
              name string
              Название системы мониторинга.
              description string
              Описание системы мониторинга.
              link string
              Ссылка на графики системы мониторинга для кластера Redis.

              ClusterConfig

              Поле Описание
              version string
              Версия серверного программного обеспечения Redis.
              redis_config oneof: redis_config_5_0
              Конфигурация для серверов Redis в кластере.
                redis_config_5_0 config.RedisConfigSet5_0
              Конфигурация сервера Redis 5.0.
              resources Resources
              Ресурсы, выделенные хостам Redis.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.
              access Access
              Политика доступа к БД

              Resources

              Поле Описание
              resource_preset_id string
              Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
              disk_size int64
              Объем хранилища, доступного хосту, в байтах.

              Access

              Поле Описание
              data_lens bool
              Разрешить доступ для DataLens

              Create

              Создает кластер Redis в указанном каталоге.

              rpc Create (CreateClusterRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:CreateClusterMetadata

                  Operation.response:Cluster

              CreateClusterRequest

              Поле Описание
              folder_id string
              Обязательное поле. Идентификатор каталога, в котором нужно создать кластер Redis. Максимальная длина строки в символах — 50.
              name string
              Обязательное поле. Имя кластера Redis. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
              description string
              Описание кластера Redis. Максимальная длина строки в символах — 256.
              labels map<string,string>
              Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
              environment Cluster.Environment
              Обязательное поле. Среда развертывания кластера Redis.
              config_spec ConfigSpec
              Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера Redis.
              host_specs[] HostSpec
              Конфигурации для отдельных хостов, которые должны быть созданы для кластера Redis. Количество элементов должно быть больше 0.
              network_id string
              Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.
              sharded bool
              Включение/выключение режима Redis Cluster.

              ConfigSpec

              Поле Описание
              version string
              Версия Redis, используемая в кластере. Единственное возможное значение — 5.0.
              redis_spec oneof: redis_config_5_0
              Конфигурация кластера Redis.
                redis_config_5_0 config.RedisConfig5_0
              Конфигурация кластера Redis.
              resources Resources
              Ресурсы, выделенные хостам Redis.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.
              access Access
              Политика доступа к БД

              Resources

              Поле Описание
              resource_preset_id string
              Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
              disk_size int64
              Объем хранилища, доступного хосту, в байтах.

              Access

              Поле Описание
              data_lens bool
              Разрешить доступ для DataLens

              HostSpec

              Поле Описание
              zone_id string
              Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List.
              subnet_id string
              Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id.
              shard_name string
              Идентификатор шарда Redis, которому принадлежит хост. Чтобы получить идентификатор шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

              Operation

              Поле Описание
              id string
              Идентификатор операции.
              description string
              Описание операции. Длина описания должна быть от 0 до 256 символов.
              created_at google.protobuf.Timestamp
              Время создания ресурса в формате в RFC3339.
              created_by string
              Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
              modified_at google.protobuf.Timestamp
              Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
              done bool
              Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
              metadata google.protobuf.Any<CreateClusterMetadata>
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
              result oneof: error или response
              Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                error google.rpc.Status
              Описание ошибки в случае сбоя или отмены операции.
                response google.protobuf.Any<Cluster>
              в случае успешного выполнения операции.

              CreateClusterMetadata

              Поле Описание
              cluster_id string
              Идентификатор создаваемого кластера Redis.

              Cluster

              Поле Описание
              id string
              Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
              folder_id string
              Идентификатор каталога, которому принадлежит кластер Redis.
              created_at google.protobuf.Timestamp
              Время создания в формате RFC3339 .
              name string
              Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
              description string
              Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
              labels map<string,string>
              Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
              environment enum Environment
              Среда развертывания кластера Redis.
              • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
              • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                monitoring[] Monitoring
                Описание систем мониторинга, относящихся к данному кластеру Redis.
                config ClusterConfig
                Конфигурация кластера Redis.
                network_id string
                health enum Health
                Агрегированная работоспособность кластера.
                • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                • ALIVE: Кластер жив и здоров (все хосты живы)
                • DEAD: Кластер не работает и не может выполнять свои основные функции
                • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                  status enum Status
                  Состояние кластера.
                  • STATUS_UNKNOWN: Состояние кластера неизвестно
                  • CREATING: Кластер создается
                  • RUNNING: Кластер работает нормально
                  • ERROR: Кластер отказал.
                  • UPDATING: Кластер изменяется.
                  • STOPPING: Кластер останавливается.
                  • STOPPED: Кластер остановлен.
                  • STARTING: Кластер запускается.
                    sharded bool
                    Включение/выключение режима Redis Cluster.

                    Monitoring

                    Поле Описание
                    name string
                    Название системы мониторинга.
                    description string
                    Описание системы мониторинга.
                    link string
                    Ссылка на графики системы мониторинга для кластера Redis.

                    ClusterConfig

                    Поле Описание
                    version string
                    Версия серверного программного обеспечения Redis.
                    redis_config oneof: redis_config_5_0
                    Конфигурация для серверов Redis в кластере.
                      redis_config_5_0 config.RedisConfigSet5_0
                    Конфигурация сервера Redis 5.0.
                    resources Resources
                    Ресурсы, выделенные хостам Redis.
                    backup_window_start google.type.TimeOfDay
                    Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                    access Access
                    Политика доступа к БД

                    Resources

                    Поле Описание
                    resource_preset_id string
                    Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                    disk_size int64
                    Объем хранилища, доступного хосту, в байтах.

                    Access

                    Поле Описание
                    data_lens bool
                    Разрешить доступ для DataLens

                    Update

                    Изменяет указанный кластер Redis.

                    rpc Update (UpdateClusterRequest) returns (operation.Operation)

                    Метаданные и результат операции:

                        Operation.metadata:UpdateClusterMetadata

                        Operation.response:Cluster

                    UpdateClusterRequest

                    Поле Описание
                    cluster_id string
                    Обязательное поле. Идентификатор кластера Redis, который следует обновить. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                    update_mask google.protobuf.FieldMask
                    Маска, которая указывает, какие поля кластера Redis должны быть изменены.
                    description string
                    Новое описание кластера Redis. Максимальная длина строки в символах — 256.
                    labels map<string,string>
                    Пользовательские метки для кластера Redis как key:value pairs. Maximum 64 per cluster. For example, project": "mvp" или "source": "dictionary". <br>Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода [ClusterService.Get](#Get), затем отправьте запрос [ClusterService.Update](#Update), добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* `.
                    config_spec ConfigSpec
                    Новая конфигурация и ресурсы для хостов кластера.
                    name string
                    Новое имя кластера. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                    ConfigSpec

                    Поле Описание
                    version string
                    Версия Redis, используемая в кластере. Единственное возможное значение — 5.0.
                    redis_spec oneof: redis_config_5_0
                    Конфигурация кластера Redis.
                      redis_config_5_0 config.RedisConfig5_0
                    Конфигурация кластера Redis.
                    resources Resources
                    Ресурсы, выделенные хостам Redis.
                    backup_window_start google.type.TimeOfDay
                    Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                    access Access
                    Политика доступа к БД

                    Resources

                    Поле Описание
                    resource_preset_id string
                    Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                    disk_size int64
                    Объем хранилища, доступного хосту, в байтах.

                    Access

                    Поле Описание
                    data_lens bool
                    Разрешить доступ для DataLens

                    Operation

                    Поле Описание
                    id string
                    Идентификатор операции.
                    description string
                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                    created_at google.protobuf.Timestamp
                    Время создания ресурса в формате в RFC3339.
                    created_by string
                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                    modified_at google.protobuf.Timestamp
                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                    done bool
                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                    metadata google.protobuf.Any<UpdateClusterMetadata>
                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                    result oneof: error или response
                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                      error google.rpc.Status
                    Описание ошибки в случае сбоя или отмены операции.
                      response google.protobuf.Any<Cluster>
                    в случае успешного выполнения операции.

                    UpdateClusterMetadata

                    Поле Описание
                    cluster_id string
                    Идентификатор изменяемого кластера Redis.

                    Cluster

                    Поле Описание
                    id string
                    Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                    folder_id string
                    Идентификатор каталога, которому принадлежит кластер Redis.
                    created_at google.protobuf.Timestamp
                    Время создания в формате RFC3339 .
                    name string
                    Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                    description string
                    Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                    labels map<string,string>
                    Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                    environment enum Environment
                    Среда развертывания кластера Redis.
                    • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                    • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                      monitoring[] Monitoring
                      Описание систем мониторинга, относящихся к данному кластеру Redis.
                      config ClusterConfig
                      Конфигурация кластера Redis.
                      network_id string
                      health enum Health
                      Агрегированная работоспособность кластера.
                      • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                      • ALIVE: Кластер жив и здоров (все хосты живы)
                      • DEAD: Кластер не работает и не может выполнять свои основные функции
                      • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                        status enum Status
                        Состояние кластера.
                        • STATUS_UNKNOWN: Состояние кластера неизвестно
                        • CREATING: Кластер создается
                        • RUNNING: Кластер работает нормально
                        • ERROR: Кластер отказал.
                        • UPDATING: Кластер изменяется.
                        • STOPPING: Кластер останавливается.
                        • STOPPED: Кластер остановлен.
                        • STARTING: Кластер запускается.
                          sharded bool
                          Включение/выключение режима Redis Cluster.

                          Monitoring

                          Поле Описание
                          name string
                          Название системы мониторинга.
                          description string
                          Описание системы мониторинга.
                          link string
                          Ссылка на графики системы мониторинга для кластера Redis.

                          ClusterConfig

                          Поле Описание
                          version string
                          Версия серверного программного обеспечения Redis.
                          redis_config oneof: redis_config_5_0
                          Конфигурация для серверов Redis в кластере.
                            redis_config_5_0 config.RedisConfigSet5_0
                          Конфигурация сервера Redis 5.0.
                          resources Resources
                          Ресурсы, выделенные хостам Redis.
                          backup_window_start google.type.TimeOfDay
                          Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                          access Access
                          Политика доступа к БД

                          Resources

                          Поле Описание
                          resource_preset_id string
                          Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                          disk_size int64
                          Объем хранилища, доступного хосту, в байтах.

                          Access

                          Поле Описание
                          data_lens bool
                          Разрешить доступ для DataLens

                          Delete

                          Удаляет указанный кластер Redis.

                          rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:DeleteClusterMetadata

                              Operation.response:google.protobuf.Empty

                          DeleteClusterRequest

                          Поле Описание
                          cluster_id string
                          Обязательное поле. Идентификатор кластера Redis, который следует удалить. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

                          Operation

                          Поле Описание
                          id string
                          Идентификатор операции.
                          description string
                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                          created_at google.protobuf.Timestamp
                          Время создания ресурса в формате в RFC3339.
                          created_by string
                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                          modified_at google.protobuf.Timestamp
                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                          done bool
                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                          metadata google.protobuf.Any<DeleteClusterMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                          result oneof: error или response
                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                            error google.rpc.Status
                          Описание ошибки в случае сбоя или отмены операции.
                            response google.protobuf.Any<google.protobuf.Empty>
                          в случае успешного выполнения операции.

                          DeleteClusterMetadata

                          Поле Описание
                          cluster_id string
                          Идентификатор удаляемого кластера Redis.

                          Start

                          Запускает указанный кластер Redis.

                          rpc Start (StartClusterRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:StartClusterMetadata

                              Operation.response:Cluster

                          StartClusterRequest

                          Поле Описание
                          cluster_id string
                          Обязательное поле. Идентификатор кластера Redis, который следует запустить. Максимальная длина строки в символах — 50.

                          Operation

                          Поле Описание
                          id string
                          Идентификатор операции.
                          description string
                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                          created_at google.protobuf.Timestamp
                          Время создания ресурса в формате в RFC3339.
                          created_by string
                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                          modified_at google.protobuf.Timestamp
                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                          done bool
                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                          metadata google.protobuf.Any<StartClusterMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                          result oneof: error или response
                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                            error google.rpc.Status
                          Описание ошибки в случае сбоя или отмены операции.
                            response google.protobuf.Any<Cluster>
                          в случае успешного выполнения операции.

                          StartClusterMetadata

                          Поле Описание
                          cluster_id string
                          Идентификатор кластера Redis.

                          Cluster

                          Поле Описание
                          id string
                          Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                          folder_id string
                          Идентификатор каталога, которому принадлежит кластер Redis.
                          created_at google.protobuf.Timestamp
                          Время создания в формате RFC3339 .
                          name string
                          Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                          description string
                          Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                          labels map<string,string>
                          Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                          environment enum Environment
                          Среда развертывания кластера Redis.
                          • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                          • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                            monitoring[] Monitoring
                            Описание систем мониторинга, относящихся к данному кластеру Redis.
                            config ClusterConfig
                            Конфигурация кластера Redis.
                            network_id string
                            health enum Health
                            Агрегированная работоспособность кластера.
                            • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                            • ALIVE: Кластер жив и здоров (все хосты живы)
                            • DEAD: Кластер не работает и не может выполнять свои основные функции
                            • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                              status enum Status
                              Состояние кластера.
                              • STATUS_UNKNOWN: Состояние кластера неизвестно
                              • CREATING: Кластер создается
                              • RUNNING: Кластер работает нормально
                              • ERROR: Кластер отказал.
                              • UPDATING: Кластер изменяется.
                              • STOPPING: Кластер останавливается.
                              • STOPPED: Кластер остановлен.
                              • STARTING: Кластер запускается.
                                sharded bool
                                Включение/выключение режима Redis Cluster.

                                Monitoring

                                Поле Описание
                                name string
                                Название системы мониторинга.
                                description string
                                Описание системы мониторинга.
                                link string
                                Ссылка на графики системы мониторинга для кластера Redis.

                                ClusterConfig

                                Поле Описание
                                version string
                                Версия серверного программного обеспечения Redis.
                                redis_config oneof: redis_config_5_0
                                Конфигурация для серверов Redis в кластере.
                                  redis_config_5_0 config.RedisConfigSet5_0
                                Конфигурация сервера Redis 5.0.
                                resources Resources
                                Ресурсы, выделенные хостам Redis.
                                backup_window_start google.type.TimeOfDay
                                Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                access Access
                                Политика доступа к БД

                                Resources

                                Поле Описание
                                resource_preset_id string
                                Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                disk_size int64
                                Объем хранилища, доступного хосту, в байтах.

                                Access

                                Поле Описание
                                data_lens bool
                                Разрешить доступ для DataLens

                                Stop

                                Останавливает указанный кластер Redis.

                                rpc Stop (StopClusterRequest) returns (operation.Operation)

                                Метаданные и результат операции:

                                    Operation.metadata:StopClusterMetadata

                                    Operation.response:Cluster

                                StopClusterRequest

                                Поле Описание
                                cluster_id string
                                Обязательное поле. Идентификатор кластера Redis, который следует остановить. Максимальная длина строки в символах — 50.

                                Operation

                                Поле Описание
                                id string
                                Идентификатор операции.
                                description string
                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                created_at google.protobuf.Timestamp
                                Время создания ресурса в формате в RFC3339.
                                created_by string
                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                modified_at google.protobuf.Timestamp
                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                done bool
                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                metadata google.protobuf.Any<StopClusterMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                result oneof: error или response
                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                  error google.rpc.Status
                                Описание ошибки в случае сбоя или отмены операции.
                                  response google.protobuf.Any<Cluster>
                                в случае успешного выполнения операции.

                                StopClusterMetadata

                                Поле Описание
                                cluster_id string
                                Идентификатор кластера Redis.

                                Cluster

                                Поле Описание
                                id string
                                Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                folder_id string
                                Идентификатор каталога, которому принадлежит кластер Redis.
                                created_at google.protobuf.Timestamp
                                Время создания в формате RFC3339 .
                                name string
                                Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                description string
                                Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                labels map<string,string>
                                Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                environment enum Environment
                                Среда развертывания кластера Redis.
                                • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                  monitoring[] Monitoring
                                  Описание систем мониторинга, относящихся к данному кластеру Redis.
                                  config ClusterConfig
                                  Конфигурация кластера Redis.
                                  network_id string
                                  health enum Health
                                  Агрегированная работоспособность кластера.
                                  • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                  • ALIVE: Кластер жив и здоров (все хосты живы)
                                  • DEAD: Кластер не работает и не может выполнять свои основные функции
                                  • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                    status enum Status
                                    Состояние кластера.
                                    • STATUS_UNKNOWN: Состояние кластера неизвестно
                                    • CREATING: Кластер создается
                                    • RUNNING: Кластер работает нормально
                                    • ERROR: Кластер отказал.
                                    • UPDATING: Кластер изменяется.
                                    • STOPPING: Кластер останавливается.
                                    • STOPPED: Кластер остановлен.
                                    • STARTING: Кластер запускается.
                                      sharded bool
                                      Включение/выключение режима Redis Cluster.

                                      Monitoring

                                      Поле Описание
                                      name string
                                      Название системы мониторинга.
                                      description string
                                      Описание системы мониторинга.
                                      link string
                                      Ссылка на графики системы мониторинга для кластера Redis.

                                      ClusterConfig

                                      Поле Описание
                                      version string
                                      Версия серверного программного обеспечения Redis.
                                      redis_config oneof: redis_config_5_0
                                      Конфигурация для серверов Redis в кластере.
                                        redis_config_5_0 config.RedisConfigSet5_0
                                      Конфигурация сервера Redis 5.0.
                                      resources Resources
                                      Ресурсы, выделенные хостам Redis.
                                      backup_window_start google.type.TimeOfDay
                                      Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                      access Access
                                      Политика доступа к БД

                                      Resources

                                      Поле Описание
                                      resource_preset_id string
                                      Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                      disk_size int64
                                      Объем хранилища, доступного хосту, в байтах.

                                      Access

                                      Поле Описание
                                      data_lens bool
                                      Разрешить доступ для DataLens

                                      Move

                                      Перемещает кластер Redis в указанный каталог.

                                      rpc Move (MoveClusterRequest) returns (operation.Operation)

                                      Метаданные и результат операции:

                                          Operation.metadata:MoveClusterMetadata

                                          Operation.response:Cluster

                                      MoveClusterRequest

                                      Поле Описание
                                      cluster_id string
                                      Обязательное поле. Идентификатор кластера Redis, который следует переместить. Максимальная длина строки в символах — 50.
                                      destination_folder_id string
                                      Обязательное поле. Идентификатор каталога, в который следует переместить кластер. Максимальная длина строки в символах — 50.

                                      Operation

                                      Поле Описание
                                      id string
                                      Идентификатор операции.
                                      description string
                                      Описание операции. Длина описания должна быть от 0 до 256 символов.
                                      created_at google.protobuf.Timestamp
                                      Время создания ресурса в формате в RFC3339.
                                      created_by string
                                      Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                      modified_at google.protobuf.Timestamp
                                      Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                      done bool
                                      Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                      metadata google.protobuf.Any<MoveClusterMetadata>
                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                      result oneof: error или response
                                      Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                        error google.rpc.Status
                                      Описание ошибки в случае сбоя или отмены операции.
                                        response google.protobuf.Any<Cluster>
                                      в случае успешного выполнения операции.

                                      MoveClusterMetadata

                                      Поле Описание
                                      cluster_id string
                                      Идентификатор перемещаемого кластера Redis.
                                      source_folder_id string
                                      Идентификатор исходного каталога.
                                      destination_folder_id string
                                      Идентификатор каталога, в который следует переместить кластер.

                                      Cluster

                                      Поле Описание
                                      id string
                                      Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                      folder_id string
                                      Идентификатор каталога, которому принадлежит кластер Redis.
                                      created_at google.protobuf.Timestamp
                                      Время создания в формате RFC3339 .
                                      name string
                                      Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                      description string
                                      Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                      labels map<string,string>
                                      Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                      environment enum Environment
                                      Среда развертывания кластера Redis.
                                      • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                      • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                        monitoring[] Monitoring
                                        Описание систем мониторинга, относящихся к данному кластеру Redis.
                                        config ClusterConfig
                                        Конфигурация кластера Redis.
                                        network_id string
                                        health enum Health
                                        Агрегированная работоспособность кластера.
                                        • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                        • ALIVE: Кластер жив и здоров (все хосты живы)
                                        • DEAD: Кластер не работает и не может выполнять свои основные функции
                                        • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                          status enum Status
                                          Состояние кластера.
                                          • STATUS_UNKNOWN: Состояние кластера неизвестно
                                          • CREATING: Кластер создается
                                          • RUNNING: Кластер работает нормально
                                          • ERROR: Кластер отказал.
                                          • UPDATING: Кластер изменяется.
                                          • STOPPING: Кластер останавливается.
                                          • STOPPED: Кластер остановлен.
                                          • STARTING: Кластер запускается.
                                            sharded bool
                                            Включение/выключение режима Redis Cluster.

                                            Monitoring

                                            Поле Описание
                                            name string
                                            Название системы мониторинга.
                                            description string
                                            Описание системы мониторинга.
                                            link string
                                            Ссылка на графики системы мониторинга для кластера Redis.

                                            ClusterConfig

                                            Поле Описание
                                            version string
                                            Версия серверного программного обеспечения Redis.
                                            redis_config oneof: redis_config_5_0
                                            Конфигурация для серверов Redis в кластере.
                                              redis_config_5_0 config.RedisConfigSet5_0
                                            Конфигурация сервера Redis 5.0.
                                            resources Resources
                                            Ресурсы, выделенные хостам Redis.
                                            backup_window_start google.type.TimeOfDay
                                            Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                            access Access
                                            Политика доступа к БД

                                            Resources

                                            Поле Описание
                                            resource_preset_id string
                                            Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                            disk_size int64
                                            Объем хранилища, доступного хосту, в байтах.

                                            Access

                                            Поле Описание
                                            data_lens bool
                                            Разрешить доступ для DataLens

                                            Backup

                                            Создает резервную копию для указанного кластера Redis.

                                            rpc Backup (BackupClusterRequest) returns (operation.Operation)

                                            Метаданные и результат операции:

                                                Operation.metadata:BackupClusterMetadata

                                                Operation.response:Cluster

                                            BackupClusterRequest

                                            Поле Описание
                                            cluster_id string
                                            Обязательное поле. Идентификатор кластера Redis для резервного копирования. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

                                            Operation

                                            Поле Описание
                                            id string
                                            Идентификатор операции.
                                            description string
                                            Описание операции. Длина описания должна быть от 0 до 256 символов.
                                            created_at google.protobuf.Timestamp
                                            Время создания ресурса в формате в RFC3339.
                                            created_by string
                                            Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                            modified_at google.protobuf.Timestamp
                                            Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                            done bool
                                            Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                            metadata google.protobuf.Any<BackupClusterMetadata>
                                            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                            result oneof: error или response
                                            Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                              error google.rpc.Status
                                            Описание ошибки в случае сбоя или отмены операции.
                                              response google.protobuf.Any<Cluster>
                                            в случае успешного выполнения операции.

                                            BackupClusterMetadata

                                            Поле Описание
                                            cluster_id string
                                            Идентификатор кластера Redis, для которого выполняется резервное копирование.

                                            Cluster

                                            Поле Описание
                                            id string
                                            Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                            folder_id string
                                            Идентификатор каталога, которому принадлежит кластер Redis.
                                            created_at google.protobuf.Timestamp
                                            Время создания в формате RFC3339 .
                                            name string
                                            Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                            description string
                                            Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                            labels map<string,string>
                                            Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                            environment enum Environment
                                            Среда развертывания кластера Redis.
                                            • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                            • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                              monitoring[] Monitoring
                                              Описание систем мониторинга, относящихся к данному кластеру Redis.
                                              config ClusterConfig
                                              Конфигурация кластера Redis.
                                              network_id string
                                              health enum Health
                                              Агрегированная работоспособность кластера.
                                              • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                              • ALIVE: Кластер жив и здоров (все хосты живы)
                                              • DEAD: Кластер не работает и не может выполнять свои основные функции
                                              • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                                status enum Status
                                                Состояние кластера.
                                                • STATUS_UNKNOWN: Состояние кластера неизвестно
                                                • CREATING: Кластер создается
                                                • RUNNING: Кластер работает нормально
                                                • ERROR: Кластер отказал.
                                                • UPDATING: Кластер изменяется.
                                                • STOPPING: Кластер останавливается.
                                                • STOPPED: Кластер остановлен.
                                                • STARTING: Кластер запускается.
                                                  sharded bool
                                                  Включение/выключение режима Redis Cluster.

                                                  Monitoring

                                                  Поле Описание
                                                  name string
                                                  Название системы мониторинга.
                                                  description string
                                                  Описание системы мониторинга.
                                                  link string
                                                  Ссылка на графики системы мониторинга для кластера Redis.

                                                  ClusterConfig

                                                  Поле Описание
                                                  version string
                                                  Версия серверного программного обеспечения Redis.
                                                  redis_config oneof: redis_config_5_0
                                                  Конфигурация для серверов Redis в кластере.
                                                    redis_config_5_0 config.RedisConfigSet5_0
                                                  Конфигурация сервера Redis 5.0.
                                                  resources Resources
                                                  Ресурсы, выделенные хостам Redis.
                                                  backup_window_start google.type.TimeOfDay
                                                  Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                                  access Access
                                                  Политика доступа к БД

                                                  Resources

                                                  Поле Описание
                                                  resource_preset_id string
                                                  Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                  disk_size int64
                                                  Объем хранилища, доступного хосту, в байтах.

                                                  Access

                                                  Поле Описание
                                                  data_lens bool
                                                  Разрешить доступ для DataLens

                                                  Restore

                                                  Создает новый кластер Redis с использованием указанной резервной копии.

                                                  rpc Restore (RestoreClusterRequest) returns (operation.Operation)

                                                  Метаданные и результат операции:

                                                      Operation.metadata:RestoreClusterMetadata

                                                      Operation.response:Cluster

                                                  RestoreClusterRequest

                                                  Поле Описание
                                                  backup_id string
                                                  Обязательное поле. Идентификатор резервной копии, из которой следует создать кластер. Чтобы получить идентификатор резервной копии, используйте запрос ClusterService.ListBackups.
                                                  name string
                                                  Обязательное поле. Имя нового кластера Redis. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                  description string
                                                  Описание нового кластера Redis. Максимальная длина строки в символах — 256.
                                                  labels map<string,string>
                                                  Пользовательские метки для кластера Redis как key:value pairs. Maximum 64 per cluster. For example, project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* `.
                                                  environment Cluster.Environment
                                                  Обязательное поле. Среда развертывания для нового кластера Redis.
                                                  config_spec ConfigSpec
                                                  Обязательное поле. Конфигурация для создаваемого кластера Redis.
                                                  host_specs[] HostSpec
                                                  Конфигурации для хостов Redis, которые должны быть созданы для кластера, создаваемого из резервной копии. Количество элементов должно быть больше 0.
                                                  network_id string
                                                  Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.
                                                  folder_id string
                                                  Идентификатор каталога, в котором нужно создать кластер Redis. Максимальная длина строки в символах — 50.

                                                  ConfigSpec

                                                  Поле Описание
                                                  version string
                                                  Версия Redis, используемая в кластере. Единственное возможное значение — 5.0.
                                                  redis_spec oneof: redis_config_5_0
                                                  Конфигурация кластера Redis.
                                                    redis_config_5_0 config.RedisConfig5_0
                                                  Конфигурация кластера Redis.
                                                  resources Resources
                                                  Ресурсы, выделенные хостам Redis.
                                                  backup_window_start google.type.TimeOfDay
                                                  Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                                  access Access
                                                  Политика доступа к БД

                                                  Resources

                                                  Поле Описание
                                                  resource_preset_id string
                                                  Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                  disk_size int64
                                                  Объем хранилища, доступного хосту, в байтах.

                                                  Access

                                                  Поле Описание
                                                  data_lens bool
                                                  Разрешить доступ для DataLens

                                                  HostSpec

                                                  Поле Описание
                                                  zone_id string
                                                  Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List.
                                                  subnet_id string
                                                  Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id.
                                                  shard_name string
                                                  Идентификатор шарда Redis, которому принадлежит хост. Чтобы получить идентификатор шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                  Operation

                                                  Поле Описание
                                                  id string
                                                  Идентификатор операции.
                                                  description string
                                                  Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                  created_at google.protobuf.Timestamp
                                                  Время создания ресурса в формате в RFC3339.
                                                  created_by string
                                                  Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                  modified_at google.protobuf.Timestamp
                                                  Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                  done bool
                                                  Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                  metadata google.protobuf.Any<RestoreClusterMetadata>
                                                  Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                  result oneof: error или response
                                                  Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                    error google.rpc.Status
                                                  Описание ошибки в случае сбоя или отмены операции.
                                                    response google.protobuf.Any<Cluster>
                                                  в случае успешного выполнения операции.

                                                  RestoreClusterMetadata

                                                  Поле Описание
                                                  cluster_id string
                                                  Идентификатор нового кластера Redis, создаваемого из резервной копии.
                                                  backup_id string
                                                  Идентификатор резервной копии, используемой для создания кластера.

                                                  Cluster

                                                  Поле Описание
                                                  id string
                                                  Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                                  folder_id string
                                                  Идентификатор каталога, которому принадлежит кластер Redis.
                                                  created_at google.protobuf.Timestamp
                                                  Время создания в формате RFC3339 .
                                                  name string
                                                  Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                                  description string
                                                  Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                                  labels map<string,string>
                                                  Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                                  environment enum Environment
                                                  Среда развертывания кластера Redis.
                                                  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                    monitoring[] Monitoring
                                                    Описание систем мониторинга, относящихся к данному кластеру Redis.
                                                    config ClusterConfig
                                                    Конфигурация кластера Redis.
                                                    network_id string
                                                    health enum Health
                                                    Агрегированная работоспособность кластера.
                                                    • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                                    • ALIVE: Кластер жив и здоров (все хосты живы)
                                                    • DEAD: Кластер не работает и не может выполнять свои основные функции
                                                    • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                                      status enum Status
                                                      Состояние кластера.
                                                      • STATUS_UNKNOWN: Состояние кластера неизвестно
                                                      • CREATING: Кластер создается
                                                      • RUNNING: Кластер работает нормально
                                                      • ERROR: Кластер отказал.
                                                      • UPDATING: Кластер изменяется.
                                                      • STOPPING: Кластер останавливается.
                                                      • STOPPED: Кластер остановлен.
                                                      • STARTING: Кластер запускается.
                                                        sharded bool
                                                        Включение/выключение режима Redis Cluster.

                                                        Monitoring

                                                        Поле Описание
                                                        name string
                                                        Название системы мониторинга.
                                                        description string
                                                        Описание системы мониторинга.
                                                        link string
                                                        Ссылка на графики системы мониторинга для кластера Redis.

                                                        ClusterConfig

                                                        Поле Описание
                                                        version string
                                                        Версия серверного программного обеспечения Redis.
                                                        redis_config oneof: redis_config_5_0
                                                        Конфигурация для серверов Redis в кластере.
                                                          redis_config_5_0 config.RedisConfigSet5_0
                                                        Конфигурация сервера Redis 5.0.
                                                        resources Resources
                                                        Ресурсы, выделенные хостам Redis.
                                                        backup_window_start google.type.TimeOfDay
                                                        Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                                        access Access
                                                        Политика доступа к БД

                                                        Resources

                                                        Поле Описание
                                                        resource_preset_id string
                                                        Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                        disk_size int64
                                                        Объем хранилища, доступного хосту, в байтах.

                                                        Access

                                                        Поле Описание
                                                        data_lens bool
                                                        Разрешить доступ для DataLens

                                                        StartFailover

                                                        Запускает ручное переключение мастера для указанного кластера Redis.

                                                        rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)

                                                        Метаданные и результат операции:

                                                            Operation.metadata:StartClusterFailoverMetadata

                                                            Operation.response:Cluster

                                                        StartClusterFailoverRequest

                                                        Поле Описание
                                                        cluster_id string
                                                        Обязательное поле. Идентификатор кластера Redis, в котором следует переключить мастер. Максимальная длина строки в символах — 50.

                                                        Operation

                                                        Поле Описание
                                                        id string
                                                        Идентификатор операции.
                                                        description string
                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                        created_at google.protobuf.Timestamp
                                                        Время создания ресурса в формате в RFC3339.
                                                        created_by string
                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                        modified_at google.protobuf.Timestamp
                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                        done bool
                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                        metadata google.protobuf.Any<StartClusterFailoverMetadata>
                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                        result oneof: error или response
                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                          error google.rpc.Status
                                                        Описание ошибки в случае сбоя или отмены операции.
                                                          response google.protobuf.Any<Cluster>
                                                        в случае успешного выполнения операции.

                                                        StartClusterFailoverMetadata

                                                        Поле Описание
                                                        cluster_id string
                                                        Идентификатор кластера Redis, для которого будет инициировано переключение мастера.

                                                        Cluster

                                                        Поле Описание
                                                        id string
                                                        Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                                        folder_id string
                                                        Идентификатор каталога, которому принадлежит кластер Redis.
                                                        created_at google.protobuf.Timestamp
                                                        Время создания в формате RFC3339 .
                                                        name string
                                                        Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                                        description string
                                                        Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                                        labels map<string,string>
                                                        Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                                        environment enum Environment
                                                        Среда развертывания кластера Redis.
                                                        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                          monitoring[] Monitoring
                                                          Описание систем мониторинга, относящихся к данному кластеру Redis.
                                                          config ClusterConfig
                                                          Конфигурация кластера Redis.
                                                          network_id string
                                                          health enum Health
                                                          Агрегированная работоспособность кластера.
                                                          • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                                          • ALIVE: Кластер жив и здоров (все хосты живы)
                                                          • DEAD: Кластер не работает и не может выполнять свои основные функции
                                                          • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                                            status enum Status
                                                            Состояние кластера.
                                                            • STATUS_UNKNOWN: Состояние кластера неизвестно
                                                            • CREATING: Кластер создается
                                                            • RUNNING: Кластер работает нормально
                                                            • ERROR: Кластер отказал.
                                                            • UPDATING: Кластер изменяется.
                                                            • STOPPING: Кластер останавливается.
                                                            • STOPPED: Кластер остановлен.
                                                            • STARTING: Кластер запускается.
                                                              sharded bool
                                                              Включение/выключение режима Redis Cluster.

                                                              Monitoring

                                                              Поле Описание
                                                              name string
                                                              Название системы мониторинга.
                                                              description string
                                                              Описание системы мониторинга.
                                                              link string
                                                              Ссылка на графики системы мониторинга для кластера Redis.

                                                              ClusterConfig

                                                              Поле Описание
                                                              version string
                                                              Версия серверного программного обеспечения Redis.
                                                              redis_config oneof: redis_config_5_0
                                                              Конфигурация для серверов Redis в кластере.
                                                                redis_config_5_0 config.RedisConfigSet5_0
                                                              Конфигурация сервера Redis 5.0.
                                                              resources Resources
                                                              Ресурсы, выделенные хостам Redis.
                                                              backup_window_start google.type.TimeOfDay
                                                              Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                                              access Access
                                                              Политика доступа к БД

                                                              Resources

                                                              Поле Описание
                                                              resource_preset_id string
                                                              Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                              disk_size int64
                                                              Объем хранилища, доступного хосту, в байтах.

                                                              Access

                                                              Поле Описание
                                                              data_lens bool
                                                              Разрешить доступ для DataLens

                                                              ListLogs

                                                              Получает логи для указанного кластера Redis.

                                                              rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

                                                              ListClusterLogsRequest

                                                              Поле Описание
                                                              cluster_id string
                                                              Обязательное поле. Идентификатор кластера Redis, для которого следует запросить логи. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                              column_filter[] string
                                                              Столбцы из таблицы логов для запроса. Если столбцы не указаны, записи логов возвращаются целиком.
                                                              service_type enum ServiceType
                                                              • REDIS: Логи работы Redis.
                                                                from_time google.protobuf.Timestamp
                                                                Начало периода, для которого следует запросить логи, в формате RFC3339.
                                                                to_time google.protobuf.Timestamp
                                                                Конец периода, для которого следует запросить логи, в формате RFC3339.
                                                                page_size int64
                                                                Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
                                                                page_token string
                                                                Токен страницы. Установите значение page_token равным значению поля ListClusterLogsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                ListClusterLogsResponse

                                                                Поле Описание
                                                                logs[] LogRecord
                                                                Запрошенные записи логов.
                                                                next_page_token string
                                                                Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterLogsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterLogsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                LogRecord

                                                                Поле Описание
                                                                timestamp google.protobuf.Timestamp
                                                                Отметка времени для записи журнала в RFC3339 текстовом формате.
                                                                message map<string,string>
                                                                Содержание записи журнала.

                                                                ListOperations

                                                                Возвращает список операций для указанного кластера.

                                                                rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                                ListClusterOperationsRequest

                                                                Поле Описание
                                                                cluster_id string
                                                                Обязательное поле. Идентификатор кластера Redis, для которого запрашивается список операций. Максимальная длина строки в символах — 50.
                                                                page_size int64
                                                                Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
                                                                page_token string
                                                                Токен страницы. Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                ListClusterOperationsResponse

                                                                Поле Описание
                                                                operations[] operation.Operation
                                                                Список операций для указанного кластера Redis.
                                                                next_page_token string
                                                                Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                Operation

                                                                Поле Описание
                                                                id string
                                                                Идентификатор операции.
                                                                description string
                                                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                created_at google.protobuf.Timestamp
                                                                Время создания ресурса в формате в RFC3339.
                                                                created_by string
                                                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                modified_at google.protobuf.Timestamp
                                                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                done bool
                                                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                metadata google.protobuf.Any
                                                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                result oneof: error или response
                                                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                  error google.rpc.Status
                                                                Описание ошибки в случае сбоя или отмены операции.
                                                                  response google.protobuf.Any
                                                                Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

                                                                ListBackups

                                                                Получает список доступных резервных копий для указанного кластера Redis.

                                                                rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

                                                                ListClusterBackupsRequest

                                                                Поле Описание
                                                                cluster_id string
                                                                Обязательное поле. Идентификатор кластера Redis. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                page_size int64
                                                                Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterBackupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
                                                                page_token string
                                                                Токен страницы. Установите значение page_token равным значению поля ListClusterBackupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                ListClusterBackupsResponse

                                                                Поле Описание
                                                                backups[] Backup
                                                                Список резервных копий Redis.
                                                                next_page_token string
                                                                Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterBackupsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterBackupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                Backup

                                                                Поле Описание
                                                                id string
                                                                Идентификатор резервной копии.
                                                                folder_id string
                                                                Идентификатор каталога, которому принадлежит резервная копия.
                                                                created_at google.protobuf.Timestamp
                                                                Время создания в формате RFC3339 (т. е. когда операция резервного копирования была завершена).
                                                                source_cluster_id string
                                                                Идентификатор кластера Redis, для которого была создана резервная копия.
                                                                started_at google.protobuf.Timestamp
                                                                Время запуска операции резервного копирования в формате RFC3339.
                                                                source_shard_names[] string
                                                                Имена шардов, которые использовались при создании резервной копии.

                                                                ListHosts

                                                                Получает список хостов для указанного кластера.

                                                                rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

                                                                ListClusterHostsRequest

                                                                Поле Описание
                                                                cluster_id string
                                                                Обязательное поле. Идентификатор кластера Redis. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                page_size int64
                                                                Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterHostsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
                                                                page_token string
                                                                Токен страницы. Установите значение page_token равным значению поля ListClusterHostsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                ListClusterHostsResponse

                                                                Поле Описание
                                                                hosts[] Host
                                                                Cписок хостов для кластера.
                                                                next_page_token string
                                                                Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterHostsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterHostsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                Host

                                                                Поле Описание
                                                                name string
                                                                Имя хоста Redis. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов.
                                                                Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
                                                                cluster_id string
                                                                Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                                                zone_id string
                                                                Идентификатор зоны доступности, в которой находится хост Redis.
                                                                subnet_id string
                                                                Идентификатор подсети, к которой принадлежит хост.
                                                                resources Resources
                                                                Ресурсы, выделенные хосту Redis.
                                                                role enum Role
                                                                Роль хоста в кластере.
                                                                • ROLE_UNKNOWN: Роль хоста в кластере неизвестна.
                                                                • MASTER: Хост является мастером в кластере Redis.
                                                                • REPLICA: Хост является репликой в кластере Redis.
                                                                  health enum Health
                                                                  Код работоспособности хоста.
                                                                  • HEALTH_UNKNOWN: Состояние хоста неизвестно.
                                                                  • ALIVE: Хозяин выполняет все свои функции нормально.
                                                                  • DEAD: Хост не работает и не может выполнять свои основные функции.
                                                                  • DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
                                                                    services[] Service
                                                                    Сервисы, предоставляемые хостом.
                                                                    shard_name string

                                                                    Resources

                                                                    Поле Описание
                                                                    resource_preset_id string
                                                                    Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                                    disk_size int64
                                                                    Объем хранилища, доступного хосту, в байтах.

                                                                    Service

                                                                    Поле Описание
                                                                    type enum Type
                                                                    Тип сервиса, предоставляемого хостом.
                                                                    • REDIS: Хост — сервер Redis.
                                                                    • ARBITER: Хост предоставляет только сервис Sentinel (хост кворума).
                                                                    • REDIS_CLUSTER: Хост является узлом Redis Cluster.
                                                                      health enum Health
                                                                      Код состояния доступности сервера.
                                                                      • HEALTH_UNKNOWN: Работоспособность сервера неизвестна.
                                                                      • ALIVE: Сервер работает нормально.
                                                                      • DEAD: Сервер отключен или не отвечает.

                                                                        AddHosts

                                                                        Создает новые хосты для кластера.

                                                                        rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

                                                                        Метаданные и результат операции:

                                                                            Operation.metadata:AddClusterHostsMetadata

                                                                            Operation.response:google.protobuf.Empty

                                                                        AddClusterHostsRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis, для которого следует добавить хосты. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        host_specs[] HostSpec
                                                                        Конфигурации для хостов Redis, которые должны быть добавлены в кластер. Количество элементов должно быть больше 0.

                                                                        HostSpec

                                                                        Поле Описание
                                                                        zone_id string
                                                                        Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List.
                                                                        subnet_id string
                                                                        Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id.
                                                                        shard_name string
                                                                        Идентификатор шарда Redis, которому принадлежит хост. Чтобы получить идентификатор шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                        Operation

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор операции.
                                                                        description string
                                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания ресурса в формате в RFC3339.
                                                                        created_by string
                                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                        modified_at google.protobuf.Timestamp
                                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                        done bool
                                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                        metadata google.protobuf.Any<AddClusterHostsMetadata>
                                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                        result oneof: error или response
                                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                          error google.rpc.Status
                                                                        Описание ошибки в случае сбоя или отмены операции.
                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                        в случае успешного выполнения операции.

                                                                        AddClusterHostsMetadata

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, в который добавляются хосты.
                                                                        host_names[] string
                                                                        Имена хостов, добавляемых в кластер.

                                                                        DeleteHosts

                                                                        Удаляет указанные хосты кластера.

                                                                        rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

                                                                        Метаданные и результат операции:

                                                                            Operation.metadata:DeleteClusterHostsMetadata

                                                                            Operation.response:google.protobuf.Empty

                                                                        DeleteClusterHostsRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis из которого следует удалить хосты. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        host_names[] string
                                                                        Имена хостов, которые следует удалить. Количество элементов должно быть больше 0. Максимальная длина строки в символах для каждого значения — 253.

                                                                        Operation

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор операции.
                                                                        description string
                                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания ресурса в формате в RFC3339.
                                                                        created_by string
                                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                        modified_at google.protobuf.Timestamp
                                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                        done bool
                                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                        metadata google.protobuf.Any<DeleteClusterHostsMetadata>
                                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                        result oneof: error или response
                                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                          error google.rpc.Status
                                                                        Описание ошибки в случае сбоя или отмены операции.
                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                        в случае успешного выполнения операции.

                                                                        DeleteClusterHostsMetadata

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, из которого следует удалить хосты.
                                                                        host_names[] string
                                                                        Имена удаляемых хостов.

                                                                        GetShard

                                                                        Возвращает указанный шард.

                                                                        rpc GetShard (GetClusterShardRequest) returns (Shard)

                                                                        GetClusterShardRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis, к которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        shard_name string
                                                                        Обязательное поле. Имя запрашиваемого шарда Redis. Чтобы получить имя шаода, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                        Shard

                                                                        Поле Описание
                                                                        name string
                                                                        Имя шарда Redis. Имя шарда назначается пользователем при создании и не может быть изменено. Длина 1-63 символов.
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, к которому принадлежит шард. Этот идентификатор генерирует MDB при создании.

                                                                        ListShards

                                                                        Получает список шардов.

                                                                        rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)

                                                                        ListClusterShardsRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера redis, для которого нужно вывести список шардов. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        page_size int64
                                                                        Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterShardsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
                                                                        page_token string
                                                                        Токен страницы. Установите значение page_token равным значению поля ListClusterShardsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                        ListClusterShardsResponse

                                                                        Поле Описание
                                                                        shards[] Shard
                                                                        Список шардов Redis.
                                                                        next_page_token string
                                                                        Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterShardsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterShardsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                        Shard

                                                                        Поле Описание
                                                                        name string
                                                                        Имя шарда Redis. Имя шарда назначается пользователем при создании и не может быть изменено. Длина 1-63 символов.
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, к которому принадлежит шард. Этот идентификатор генерирует MDB при создании.

                                                                        AddShard

                                                                        Создает новый шард.

                                                                        rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

                                                                        Метаданные и результат операции:

                                                                            Operation.metadata:AddClusterShardMetadata

                                                                            Operation.response:Shard

                                                                        AddClusterShardRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis, в котором следует создать шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        shard_name string
                                                                        Обязательное поле. Имя шарда. Имя должно быть уникальным в пределах кластера. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                                        host_specs[] HostSpec
                                                                        Конфигурации для хостов Redis, которые должны быть созданы вместе с шардом. Должен содержать хотя бы один элемент. Количество элементов должно быть больше 0.

                                                                        HostSpec

                                                                        Поле Описание
                                                                        zone_id string
                                                                        Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List.
                                                                        subnet_id string
                                                                        Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id.
                                                                        shard_name string
                                                                        Идентификатор шарда Redis, которому принадлежит хост. Чтобы получить идентификатор шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                        Operation

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор операции.
                                                                        description string
                                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания ресурса в формате в RFC3339.
                                                                        created_by string
                                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                        modified_at google.protobuf.Timestamp
                                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                        done bool
                                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                        metadata google.protobuf.Any<AddClusterShardMetadata>
                                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                        result oneof: error или response
                                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                          error google.rpc.Status
                                                                        Описание ошибки в случае сбоя или отмены операции.
                                                                          response google.protobuf.Any<Shard>
                                                                        в случае успешного выполнения операции.

                                                                        AddClusterShardMetadata

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, в который добавляется шард.
                                                                        shard_name string
                                                                        Имя создаваемого шарда Redis.

                                                                        Shard

                                                                        Поле Описание
                                                                        name string
                                                                        Имя шарда Redis. Имя шарда назначается пользователем при создании и не может быть изменено. Длина 1-63 символов.
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, к которому принадлежит шард. Этот идентификатор генерирует MDB при создании.

                                                                        DeleteShard

                                                                        Удаляет указанный шард.

                                                                        rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)

                                                                        Метаданные и результат операции:

                                                                            Operation.metadata:DeleteClusterShardMetadata

                                                                            Operation.response:google.protobuf.Empty

                                                                        DeleteClusterShardRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis, к которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                        shard_name string
                                                                        Обязательное поле. Имя шарда Redis, который следует удалить. Чтобы получить имя шаода, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                        Operation

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор операции.
                                                                        description string
                                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания ресурса в формате в RFC3339.
                                                                        created_by string
                                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                        modified_at google.protobuf.Timestamp
                                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                        done bool
                                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                        metadata google.protobuf.Any<DeleteClusterShardMetadata>
                                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                        result oneof: error или response
                                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                          error google.rpc.Status
                                                                        Описание ошибки в случае сбоя или отмены операции.
                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                        в случае успешного выполнения операции.

                                                                        DeleteClusterShardMetadata

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, к которому принадлежит шард.
                                                                        shard_name string
                                                                        Имя удаляемого шарда Redis.

                                                                        Rebalance

                                                                        Перебалансирует кластер. Равномерно распределяет все хэш-слоты между шардами.

                                                                        rpc Rebalance (RebalanceClusterRequest) returns (operation.Operation)

                                                                        Метаданные и результат операции:

                                                                            Operation.metadata:RebalanceClusterMetadata

                                                                            Operation.response:Cluster

                                                                        RebalanceClusterRequest

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Обязательное поле. Идентификатор кластера Redis, который следует перебалансировать. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

                                                                        Operation

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор операции.
                                                                        description string
                                                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания ресурса в формате в RFC3339.
                                                                        created_by string
                                                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                        modified_at google.protobuf.Timestamp
                                                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                        done bool
                                                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                        metadata google.protobuf.Any<RebalanceClusterMetadata>
                                                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                        result oneof: error или response
                                                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                          error google.rpc.Status
                                                                        Описание ошибки в случае сбоя или отмены операции.
                                                                          response google.protobuf.Any<Cluster>
                                                                        в случае успешного выполнения операции.

                                                                        RebalanceClusterMetadata

                                                                        Поле Описание
                                                                        cluster_id string
                                                                        Идентификатор кластера Redis, для которого выполняется перебалансировка.

                                                                        Cluster

                                                                        Поле Описание
                                                                        id string
                                                                        Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
                                                                        folder_id string
                                                                        Идентификатор каталога, которому принадлежит кластер Redis.
                                                                        created_at google.protobuf.Timestamp
                                                                        Время создания в формате RFC3339 .
                                                                        name string
                                                                        Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
                                                                        description string
                                                                        Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
                                                                        labels map<string,string>
                                                                        Пользовательские метки для кластера Redis в виде пар key:value. Максимум 64 на кластер.
                                                                        environment enum Environment
                                                                        Среда развертывания кластера Redis.
                                                                        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                                        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                                          monitoring[] Monitoring
                                                                          Описание систем мониторинга, относящихся к данному кластеру Redis.
                                                                          config ClusterConfig
                                                                          Конфигурация кластера Redis.
                                                                          network_id string
                                                                          health enum Health
                                                                          Агрегированная работоспособность кластера.
                                                                          • HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных)
                                                                          • ALIVE: Кластер жив и здоров (все хосты живы)
                                                                          • DEAD: Кластер не работает и не может выполнять свои основные функции
                                                                          • DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
                                                                            status enum Status
                                                                            Состояние кластера.
                                                                            • STATUS_UNKNOWN: Состояние кластера неизвестно
                                                                            • CREATING: Кластер создается
                                                                            • RUNNING: Кластер работает нормально
                                                                            • ERROR: Кластер отказал.
                                                                            • UPDATING: Кластер изменяется.
                                                                            • STOPPING: Кластер останавливается.
                                                                            • STOPPED: Кластер остановлен.
                                                                            • STARTING: Кластер запускается.
                                                                              sharded bool
                                                                              Включение/выключение режима Redis Cluster.

                                                                              Monitoring

                                                                              Поле Описание
                                                                              name string
                                                                              Название системы мониторинга.
                                                                              description string
                                                                              Описание системы мониторинга.
                                                                              link string
                                                                              Ссылка на графики системы мониторинга для кластера Redis.

                                                                              ClusterConfig

                                                                              Поле Описание
                                                                              version string
                                                                              Версия серверного программного обеспечения Redis.
                                                                              redis_config oneof: redis_config_5_0
                                                                              Конфигурация для серверов Redis в кластере.
                                                                                redis_config_5_0 config.RedisConfigSet5_0
                                                                              Конфигурация сервера Redis 5.0.
                                                                              resources Resources
                                                                              Ресурсы, выделенные хостам Redis.
                                                                              backup_window_start google.type.TimeOfDay
                                                                              Время запуска ежедневного резервного копирования, в часовом поясе UTC.
                                                                              access Access
                                                                              Политика доступа к БД

                                                                              Resources

                                                                              Поле Описание
                                                                              resource_preset_id string
                                                                              Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                                              disk_size int64
                                                                              Объем хранилища, доступного хосту, в байтах.

                                                                              Access

                                                                              Поле Описание
                                                                              data_lens bool
                                                                              Разрешить доступ для DataLens
                                                                              В этой статье: