Перейти к основному содержанию
GET
List available service profiles
Returns the custom instance profiles the organization can use in a region. Pass byoc_id to list the profiles configured for a BYOC infrastructure; the region is then taken from the infrastructure and region_id may be omitted. v2-default (Gen 2 hardware) is listed for organizations with Gen 2 enabled and included in their plan (SCALE or ENTERPRISE) or settings, in AWS regions where Gen 2 is available, and never for BYOC infrastructure. Some other profiles have their own availability rules; every other profile, v1-default included, is listed only when the organization has custom hardware profiles (through its plan or a per-organization override).

Permission

The API key must have the control-plane:organization:view permission.

Авторизации

Authorization
string
header
обязательно

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Параметры пути

organizationId
string<uuid>
обязательно

ID of the organization to list available profiles for.

Параметры запроса

region_id
string

Region to list profiles for, e.g. us-east-1. Required unless byoc_id is set; when both are set it must match the BYOC infrastructure's region.

byoc_id
string<uuid>

ID of the BYOC infrastructure to list profiles for. BYOC profiles are only returned when this is set.

Ответ

Successful response

status
number

HTTP status code.

Пример:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]