Управление сервисом ClickHouse Cloud с помощью API и cURL

Узнайте, как запускать, останавливать и возобновлять работу сервиса ClickHouse Cloud с помощью конечных точек API и команд cURL.

​

Как запустить, остановить и возобновить работу сервиса ClickHouse Cloud с помощью API ClickHouse и cURL

​

Вопрос

Как запускать, останавливать и возобновлять сервис ClickHouse Cloud через конечные точки API?

​

Ответ

1. Чтобы вывести сервис ClickHouse Cloud из бездействующего состояния и возобновить его работу, можно отправить экземпляру пакет Ping:

curl -X GET https://abc123.us-west-2.aws.clickhouse.cloud:8443/ping

2. Чтобы остановить сервис ClickHouse Cloud, используйте конечную точку /state с командой stop. Синтаксис выглядит так:

curl -X PATCH https://api.clickhouse.cloud/v1/organizations/<org_uuid>/services/<service_uuid>/state -u <key_id>:<key_secret> -H "Content-Type: application/json" -d ''{"command": "<stop|start>"}''

Например, следующая команда останавливает сервис 2e2124ca-c5ac-459d-a6f2-abc123549d2a:

curl -X PATCH https://api.clickhouse.cloud/v1/organizations/123abcd0-e9b5-4f55-9e42-0fb04392445c/services/2e2124ca-c5ac-459d-a6f2-abc123549d2a/state -u abc123:ABC123 -H "Content-Type: application/json" -d '{"command": "stop"}'

Вывод выглядит так:

{"result":{"id":"2e2124ca-c5ac-459d-a6f2-abc123549d2a","name":"mars-s3","provider":"aws","regionId":"us-west-2","state":"stopping","endpoints":[{"protocol":"nativesecure","host":"abc123.us-west-2.aws.clickhouse.cloud","port":9440},{"protocol":"https","host":"abc123ntrb.us-west-2.aws.clickhouse.cloud","port":8443}],"tier":"production","idleScaling":true,"idleTimeoutMinutes":5,"minTotalMemoryGb":24,"maxTotalMemoryGb":48,"ipAccessList":[{"source":"[0.0.0.0/0](http://0.0.0.0/0)","description":"Anywhere"}],"createdAt":"2022-10-21T18:46:31Z"},"status":200}%

3. Чтобы снова запустить сервис, используйте команду start:

curl -X PATCH https://api.clickhouse.cloud/v1/organizations/123abcd0-e9b5-4f55-9e42-0fb04392445c/services/2e2124ca-c5ac-459d-a6f2-abc123549d2a/state -u abc123:ABC123 -H "Content-Type: application/json" -d '{"command": "start"}'

Вот возможные состояния сервиса:

"state":"stopping"
"state":"stopped"
"state":"starting"
"state":"running"
"state":"idle"

Сервис ClickHouse Cloud со статусом “idle” считается запущенным, поэтому команда start не возобновит его работу и не выведет из этого состояния. Чтобы активировать сервис, используйте конечную точку ping, показанную в шаге 1.