Managed Service for ClickHouse API, REST: FormatSchema.List
Returns a list of format schemas in a cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/formatSchemas
Path parameters
Field |
Description |
clusterId |
string Required field. ClickHouse cluster ID. To get a ClickHouse cluster ID, use the ClusterService.List method. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of the results is larger than |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"formatSchemas": [
{
"name": "string",
"clusterId": "string",
"type": "string",
"uri": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
formatSchemas[] |
List of format schemas. |
nextPageToken |
string This token allows you to get the next page of results when requesting the format schema list. If the number of the results is larger than ListFormatSchemasRequest.pageSize, use the |
FormatSchema
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. |