Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Managed Service for SQL Server™
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
    • Остановка и запуск кластера
    • Изменение настроек кластера и базы данных
    • Управление хостами SQL Server
    • Управление базами данных
    • Управление пользователями
    • Назначение привилегий и ролей
    • Управление резервными копиями
    • Удаление кластера
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
    • Сеть в Managed Service for SQL Server
    • Квоты и лимиты
    • Типы хранилища
    • Резервные копии
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • BackupService
      • ClusterService
      • DatabaseService
      • OperationService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST
      • Обзор
      • Backup
        • Обзор
        • get
        • list
      • Cluster
        • Обзор
        • backup
        • create
        • delete
        • get
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • move
        • restore
        • start
        • stop
        • update
      • Database
        • Обзор
        • create
        • delete
        • get
        • list
      • Operation
        • Обзор
        • get
      • ResourcePreset
        • Обзор
        • get
        • list
      • User
        • Обзор
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
  • Вопросы и ответы
    • Общие вопросы
  1. Справочник API
  2. gRPC
  3. DatabaseService

DatabaseService

  • Вызовы DatabaseService
  • Get
    • GetDatabaseRequest
    • Database
  • List
    • ListDatabasesRequest
    • ListDatabasesResponse
    • Database
  • Create
    • CreateDatabaseRequest
    • DatabaseSpec
    • Operation
    • CreateDatabaseMetadata
    • Database
  • Delete
    • DeleteDatabaseRequest
    • Operation
    • DeleteDatabaseMetadata

Набор методов для управления базами данных SQL Server.

Вызов Описание
Get Возвращает указанную базу данных SQL Server.
List Возвращает список баз данных SQL Server в указанном кластере.
Create Создает новую базу данных SQL Server в указанном кластере.
Delete Удаляет указанную базу данных SQL Server.

Вызовы DatabaseService

Get

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

rpc Get (GetDatabaseRequest) returns (Database)

GetDatabaseRequest

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

Database

Поле Описание
name string
Имя базы данных.
cluster_id string
Идентификатор кластера SQL Server, которому принадлежит база данных.

List

Возвращает список баз данных SQL Server в указанном кластере.

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequest

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

ListDatabasesResponse

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

Database

Поле Описание
name string
Имя базы данных.
cluster_id string
Идентификатор кластера SQL Server, которому принадлежит база данных.

Create

Создает новую базу данных SQL Server в указанном кластере.

rpc Create (CreateDatabaseRequest) returns (operation.Operation)

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

    Operation.metadata:CreateDatabaseMetadata

    Operation.response:Database

CreateDatabaseRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера SQL Server, в котором следует создать базу данных.
Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
database_spec DatabaseSpec
Обязательное поле. Configuration of the database to create.

DatabaseSpec

Поле Описание
name string
Обязательное поле. Имя базы данных. Максимальная длина строки в символах — 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<CreateDatabaseMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Database>
в случае успешного выполнения операции.

CreateDatabaseMetadata

Поле Описание
cluster_id string
Идентификатор кластера SQL Server, в котором создается база данных.
database_name string
Имя создаваемой базы данных SQL Server.

Database

Поле Описание
name string
Имя базы данных.
cluster_id string
Идентификатор кластера SQL Server, которому принадлежит база данных.

Delete

Удаляет указанную базу данных SQL Server.

rpc Delete (DeleteDatabaseRequest) returns (operation.Operation)

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

    Operation.metadata:DeleteDatabaseMetadata

    Operation.response:google.protobuf.Empty

DeleteDatabaseRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера SQL Server, в котором следует удалить базу данных.
Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
database_name string
Обязательное поле. Имя удаляемой базы данных.
Чтобы получить имя базы данных, используйте запрос DatabaseService.List. Максимальная длина строки в символах — 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<DeleteDatabaseMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
в случае успешного выполнения операции.

DeleteDatabaseMetadata

Поле Описание
cluster_id string
Идентификатор кластера SQL Server, в котором удаляется база данных.
database_name string
Имя удаляемой базы данных SQL Server.
В этой статье:
  • Вызовы DatabaseService
  • Get
  • GetDatabaseRequest
  • Database
  • List
  • ListDatabasesRequest
  • ListDatabasesResponse
  • Database
  • Create
  • CreateDatabaseRequest
  • DatabaseSpec
  • Operation
  • CreateDatabaseMetadata
  • Database
  • Delete
  • DeleteDatabaseRequest
  • Operation
  • DeleteDatabaseMetadata
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»