Managed Service for ClickHouse API, REST: FormatSchema.get
Written by
Updated at November 21, 2023
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
Parameter | Description |
---|---|
clusterId | Required. ClickHouse cluster ID. To get a ClickHouse cluster ID, use the list method. The maximum string length in characters is 50. |
formatSchemaName | Required. Format schema name. To get a format schema name, use the list method. The maximum string length in characters is 63. Value must match the regular expression |
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 | string 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. |