DBaaS Service Clickhouse
Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | yes | Service name Min length: 0. Max length: 63. |
plan | string | yes | Subscription plan |
prometheus-uri | Prometheus URI | yes | Prometheus integration URI |
type | string | yes | Service type code Min length: 0. Max length: 64. |
backups | array of List of backups for the service | no | List of backups for the service |
clickhouse-settings | ClickHouse settings | no | ClickHouse-specific settings |
components | array of Components | no | Service component information objects |
connection-info | Connection Info | no | ClickHouse connection information properties |
created-at | string | no | Service creation timestamp (ISO 8601) ISO 8601 date-time. |
disk-size | integer | no | TODO UNIT disk space for data storage Min: 0. |
integrations | array of DBaaS Integration | no | Service integrations |
ip-filter | array[string] | no | Allowed CIDR address blocks for incoming connections |
maintenance | Automatic maintenance settings | no | Automatic maintenance settings |
node-count | integer | no | Number of service nodes in the active plan Min: 0. |
node-cpu-count | integer | no | Number of CPUs for each node Min: 0. |
node-memory | integer | no | TODO UNIT of memory for each node Min: 0. |
node-states | array of Automatic maintenance settings | no | State of individual service nodes |
notifications | array of Service notifications | no | Service notifications |
state | string | no | State of the service Allowed values: running, rebuilding, rebalancing, poweroff. |
termination-protection | boolean | no | Service is protected against termination and powering off |
updated-at | string | no | Service last update timestamp (ISO 8601) ISO 8601 date-time. |
uri | string | no | URI for connecting to the service (may be absent) |
uri-params | object | no | service_uri parameterized into key-value pairs |
users | array of DBaaS Clickhouse User | no | List of ClickHouse users |
version | string | no | ClickHouse version |
zone | string | no | The zone where the service is running |
Connection Info
ClickHouse connection information properties
| Property | Type | Required | Description |
|---|---|---|---|
arrowflight-uri | string | no | |
mysql-uri | string | no | |
uri | array[string] | no |
Prometheus URI
Prometheus integration URI
| Property | Type | Required | Description |
|---|---|---|---|
host | string | no | |
port | integer | no | Min: 0. Max: 65535. |
Components
| Property | Type | Required | Description |
|---|---|---|---|
component | string | yes | Service component name |
host | string | yes | DNS name for connecting to the service component |
port | integer | yes | Port number for connecting to the service component Min: 0. Max: 65535. |
route | string | yes | Network access route Allowed values: dynamic, private, public, privatelink. |
usage | string | yes | DNS usage name Allowed values: primary, replica. |
ssl | boolean | no | Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption. |
Last updated on