Skip to content

Commit de58eca

Browse files
authored
Update api-overview.md with OpenAPI settings
1 parent d81639b commit de58eca

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/cloud/manage/api/api-overview.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ consume the ClickHouse Cloud API docs, we offer a JSON-based Swagger endpoint
2525
via https://api.clickhouse.cloud/v1. You can also find the API docs via
2626
the [Swagger UI](https://clickhouse.com/docs/cloud/manage/api/swagger).
2727

28+
:::note
29+
If your organization has been migrated to one of the [new pricing plans](https://clickhouse.com/pricing?plan=scale&provider=aws&region=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+
2835
## Rate limits {#rate-limits}
2936

3037
Developers are limited to 100 API keys per organization. Each API key has a
@@ -44,11 +51,16 @@ If you'd like to contribute to the ClickHouse Terraform Provider, you can view
4451
the source [in the GitHub repo](https://github.com/ClickHouse/terraform-provider-clickhouse).
4552

4653
:::note
47-
If your organization has been migrated to one of the [new pricing plans](https://clickhouse.com/pricing?plan=scale&provider=aws&region=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.
54+
If your organization has been migrated to one of the [new pricing plans](https://clickhouse.com/pricing?plan=scale&provider=aws&region=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.
4855

49-
You will now also be able to specify the num_replicas field as a property of the service resource. 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. For the Scale and the Enterprise tiers, it is possible to adjust it by passing a numReplicas field in the service creation request. The value of the num_replicas filed 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.
56+
You will now also be able to specify the `num_replicas` field as a property of the service resource.
5057
:::
5158

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+
5264
## Support {#support}
5365

5466
We recommend visiting [our Slack channel](https://clickhouse.com/slack) first to get quick support. If

0 commit comments

Comments
 (0)