Managed Service for ClickHouse API, REST: FormatSchema.Get

Written by

Updated at October 17, 2024

Returns detailed information about a given format schema.

HTTP request

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

Field

Description

clusterId

string

Required field. ClickHouse cluster ID.

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

formatSchemaName

string

Required field. Format schema name.

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

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_UNSPECIFIED` `FORMAT_SCHEMA_TYPE_PROTOBUF` `FORMAT_SCHEMA_TYPE_CAPNPROTO`
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.