Yandex Cloud
КейсыДокументация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Managed Service for ClickHouse®
  • Начало работы
  • Управление доступом
  • Инспекции и рекомендации
  • Правила тарификации
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Метрики Yandex Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Обучающие курсы

В этой статье:

  • HTTP request
  • Path parameters
  • Response
  1. Справочник API
  2. REST (англ.)
  3. FormatSchema
  4. Get

Managed Service for ClickHouse API, REST: FormatSchema.Get

Статья создана
Yandex Cloud
Обновлена 15 июня 2026 г.
Открыть в Markdown
  • HTTP request
  • Path parameters
  • Response

Returns detailed information about a given format schema.

HTTP requestHTTP request

GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/formatSchemas/{formatSchemaName}

Path parametersPath parameters

Field

Description

clusterId

string

Required field. ClickHouse cluster ID.
To get a ClickHouse cluster ID, use the ClusterService.List method.

The maximum string length in characters is 50.

formatSchemaName

string

Required field. Format schema name.
To get a format schema name, use the FormatSchemaService.List method.

The maximum string length in characters is 63.

ResponseResponse

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "type": "string",
  "uri": "string"
}

Field

Description

name

string

Format schema name.

clusterId

string

ClickHouse cluster ID.

type

enum (FormatSchemaType)

Schema type. Possible values are the following:

  • FORMAT_SCHEMA_TYPE_PROTOBUF - Protobuf data format (including ProtobufSingle).
  • FORMAT_SCHEMA_TYPE_CAPNPROTO - Cap'n Proto data format.
  • FORMAT_SCHEMA_TYPE_PROTOBUF: Protobuf data format (including ProtobufSingle).
  • FORMAT_SCHEMA_TYPE_CAPNPROTO: Cap'n Proto data format.

uri

string

Link to the file of a format schema in Yandex Object Storage. Managed Service for ClickHouse works only with format schemas imported to Object Storage.

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

Предыдущая
Overview
Следующая
List
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»