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
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. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of the results is larger than pageSize, the service returns nextPageToken. You can use it to get the next page of the results in subsequent requests of a format schema list. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous format schema list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"formatSchemas": [
{
"name": "string",
"clusterId": "string",
"type": "string",
"uri": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
formatSchemas[] | object List of format schemas. |
formatSchemas[]. name |
string Format schema name. |
formatSchemas[]. clusterId |
string ClickHouse cluster ID. |
formatSchemas[]. type |
string Schema type. Possible values are the following:
|
formatSchemas[]. 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. |
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 pageSize, use the nextPageToken as the value for the pageToken parameter in the next request. Each subsequent request will have its own nextPageToken to continue paging through the results. |