Managed Service for ClickHouse API, REST: FormatSchema.Get
Статья создана
Обновлена 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}
Path parameters
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. |
Response
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:
|
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. |