You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/manage/api/api-overview.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,13 @@ consume the ClickHouse Cloud API docs, we offer a JSON-based Swagger endpoint
25
25
via https://api.clickhouse.cloud/v1. You can also find the API docs via
26
26
the [Swagger UI](https://clickhouse.com/docs/cloud/manage/api/swagger).
27
27
28
+
:::note
29
+
If your organization has been migrated to one of the [new pricing plans](https://clickhouse.com/pricing?plan=scale&provider=aws®ion=us-east-1&hours=8&storageCompressed=false), and you use OpenAPI you will be required to remove the `tier` field in the service creation `POST` request.
30
+
31
+
The `tier` field has been removed from the service object as we no longer have service tiers.
32
+
This will affect the objects returned by the `POST`, `GET`, and `PATCH` service requests. Therefore, any code that consumes these APIs may need to be adjusted to handle these changes.
33
+
:::
34
+
28
35
## Rate limits {#rate-limits}
29
36
30
37
Developers are limited to 100 API keys per organization. Each API key has a
@@ -43,6 +50,17 @@ You can view the Terraform provider docs in the [Terraform registry](https://reg
43
50
If you'd like to contribute to the ClickHouse Terraform Provider, you can view
44
51
the source [in the GitHub repo](https://github.com/ClickHouse/terraform-provider-clickhouse).
45
52
53
+
:::note
54
+
If your organization has been migrated to one of the [new pricing plans](https://clickhouse.com/pricing?plan=scale&provider=aws®ion=us-east-1&hours=8&storageCompressed=false), you will be required to use our [ClickHouse Terraform provider](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs) version 2.0.0 or above. This upgrade is required to handle changes in the `tier` attribute of the service since, after pricing migration, the `tier` field is no longer accepted and references to it should be removed.
55
+
56
+
You will now also be able to specify the `num_replicas` field as a property of the service resource.
57
+
:::
58
+
59
+
## Terraform and OpenAPI New Pricing: Replica Settings Explained
60
+
The number of replicas each service will be created with defaults to 3 for the Scale and Enterprise tiers, while it defaults to 1 for the Basic tier.
61
+
For the Scale and the Enterprise tiers it is possible to adjust it by passing a `numReplicas` field in the service creation request.
62
+
The value of the `numReplicas` field must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1.
63
+
46
64
## Support {#support}
47
65
48
66
We recommend visiting [our Slack channel](https://clickhouse.com/slack) first to get quick support. If
0 commit comments