服务
组织服务列表
返回组织中所有服务的列表。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
创建新服务
在组织中创建新服务，并返回当前服务状态和访问服务的密码。服务异步启动。
| 方法 | 路径 |
|---|---|
| POST | /v1/organizations/{organizationId}/services |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 将拥有该服务的组织的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| backupId | string | 可选的备份 ID，用作新服务的初始状态。使用时，新实例的区域和层级必须与原始实例的值相同。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| privateEndpointIds | array | 私有端点列表 |
| privatePreviewTermsChecked | boolean | 接受私有预览条款和条件。仅在私有预览情况下在组织中创建第一个服务时才需要 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| service | ||
| password | string | 新创建服务的密码。 |
示例响应
{
"password": "string"
}
获取服务详情
返回属于该组织的服务
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
更新服务基本详情
更新基本服务详情，例如服务名称或 IP 访问列表。
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要更新的服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| ipAccessList | ||
| privateEndpointIds | ||
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
删除服务
删除服务。服务必须处于停止状态，并在调用此方法后异步删除。
| 方法 | 路径 |
|---|---|
| DELETE | /v1/organizations/{organizationId}/services/{serviceId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要删除的服务的 ID。 |
获取私有端点配置
设置私有端点所需的信息
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| endpointServiceId | string | 您在 VPC 中使用 AWS(服务名称)、GCP(目标服务) 或 AZURE (私有链接服务) 资源创建的接口端点的唯一标识符 |
| privateDnsHostname | string | 您创建的 VPC 的私有 DNS 主机名 |
示例响应
{
"endpointServiceId": "string",
"privateDnsHostname": "string"
}
获取给定实例的服务查询端点
这是一个实验性功能。请联系支持人员以启用它。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 服务查询端点的 ID |
| openApiKeys | array | 可以访问服务查询端点的 OpenAPI 密钥列表 |
| roles | array | 可以访问服务查询端点的角色列表 |
| allowedOrigins | string | 允许的来源，以逗号分隔的域名列表 |
示例响应
{
"id": "string",
"openApiKeys": "Array",
"roles": "Array",
"allowedOrigins": "string"
}
删除给定实例的服务查询端点
这是一个实验性功能。请联系支持人员以启用它。
| 方法 | 路径 |
|---|---|
| DELETE | /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
更新或插入给定实例的服务查询端点
这是一个实验性功能。请联系支持人员以启用它。
| 方法 | 路径 |
|---|---|
| POST | /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roles | array | 角色 |
| openApiKeys | array | 服务查询端点的版本 |
| allowedOrigins | string | 允许的来源，以逗号分隔的域名列表 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 服务查询端点的 ID |
| openApiKeys | array | 可以访问服务查询端点的 OpenAPI 密钥列表 |
| roles | array | 可以访问服务查询端点的角色列表 |
| allowedOrigins | string | 允许的来源，以逗号分隔的域名列表 |
示例响应
{
"id": "string",
"openApiKeys": "Array",
"roles": "Array",
"allowedOrigins": "string"
}
更新服务状态
启动或停止服务
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId}/state |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要更新状态的服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| command | string | 更改状态的命令：“启动”、“停止”。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
更新服务自动扩展设置
更新服务的最小和最大总内存限制以及空闲模式扩展行为。内存设置仅适用于“生产”服务，并且必须是 12 的倍数，从 24GB 开始。请联系支持人员以启用 numReplicas 的调整。
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId}/scaling |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要更新扩展参数的服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 自动扩展期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 自动扩展期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（非付费服务）或 236*（付费服务）。* - 最大副本大小受云提供商在您选择的区域的硬件可用性限制。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
更新服务自动扩展设置
更新服务的每个副本的最小和最大内存限制以及空闲模式扩展行为。内存设置仅适用于“生产”服务，并且必须是 4 的倍数，从 8GB 开始。请联系支持人员以启用 numReplicas 的调整。
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId}/replicaScaling |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要更新扩展参数的服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| minReplicaMemoryGb | number | 单个副本的最小自动扩展内存（Gb）。仅适用于“生产”服务。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 单个副本的最大自动扩展内存（Gb）。仅适用于“生产”服务。必须是 4 的倍数且小于或等于 120（非付费服务）或 236（付费服务）。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一服务 ID。 |
| name | string | 服务名称。字母数字字符串，最多 50 个字符，允许空格。 |
| provider | string | 云提供商 |
| region | string | 服务区域。 |
| state | string | 服务的当前状态。 |
| endpoints | array | 所有服务端点的列表。 |
| tier | string | 服务层级：'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。生产服务可扩展，开发服务大小固定。Azure 服务不支持开发层级 |
| minTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最小内存（Gb）。仅适用于“生产”服务。必须是 12 的倍数且大于或等于 24。 |
| maxTotalMemoryGb | number | 已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个 worker 的最大内存（Gb）。仅适用于“生产”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。 |
| minReplicaMemoryGb | number | 单个副本的最小自动扩展内存（Gb）。仅适用于“生产”服务。必须是 4 的倍数且大于或等于 8。 |
| maxReplicaMemoryGb | number | 单个副本的最大自动扩展内存（Gb）。仅适用于“生产”服务。必须是 4 的倍数且小于或等于 120（非付费服务）或 236（付费服务）。 |
| numReplicas | number | 服务的副本数量。必须介于 1 到 20 之间。请联系支持人员以启用此功能。 |
| idleScaling | boolean | 设置为 true 时，允许服务在空闲时缩减到零。默认为 true。 |
| idleTimeoutMinutes | number | 设置最小空闲超时时间（分钟）。必须 >= 5 分钟。 |
| ipAccessList | array | 允许访问服务的 IP 地址列表 |
| createdAt | date-time | 服务创建时间戳。ISO-8601。 |
| encryptionKey | string | 可选的客户提供的磁盘加密密钥 |
| encryptionAssumedRoleIdentifier | string | 用于磁盘加密的可选角色 |
| iamRole | string | 用于访问 s3 中对象的 IAM 角色 |
| privateEndpointIds | array | 私有端点列表 |
| dataWarehouseId | string | 包含此服务的数据仓库 |
| isPrimary | boolean | 如果此服务是数据仓库中的主服务，则为 True |
| isReadonly | boolean | 如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能为只读。 |
| releaseChannel | string | 如果您希望尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但也面临更高的错误风险。此功能仅适用于生产服务。 |
| byocId | string | 这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。 |
示例响应
{
"id": "uuid",
"name": "string",
"provider": "string",
"region": "string",
"state": "string",
"endpoints": "Array",
"tier": "string",
"minTotalMemoryGb": 0,
"maxTotalMemoryGb": 0,
"minReplicaMemoryGb": 0,
"maxReplicaMemoryGb": 0,
"numReplicas": 0,
"idleScaling": "boolean",
"idleTimeoutMinutes": 0,
"ipAccessList": "Array",
"createdAt": "date-time",
"encryptionKey": "string",
"encryptionAssumedRoleIdentifier": "string",
"iamRole": "string",
"privateEndpointIds": "Array",
"dataWarehouseId": "string",
"isPrimary": "boolean",
"isReadonly": "boolean",
"releaseChannel": "string",
"byocId": "string"
}
更新服务密码
为服务设置新密码
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId}/password |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 要更新密码的服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| newPasswordHash | string | 可选的密码哈希。用于避免通过网络传输密码。如果未提供，则会生成新密码并在响应中提供。否则，将使用此哈希。算法：echo -n "yourpassword" |
| newDoubleSha1Hash | string | MySQL 协议的可选双 SHA1 密码哈希。如果未提供 newPasswordHash，则将忽略此密钥，并将使用生成的密码。算法：echo -n "yourpassword" |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| password | string | 新服务密码。仅当请求中没有 'newPasswordHash' 时提供 |
示例响应
{
"password": "string"
}
获取 Prometheus 指标
返回服务的 Prometheus 指标。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/prometheus |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 请求的服务 ID。 |
| filtered_metrics | boolean | 返回 Prometheus 指标的筛选列表。 |
服务备份列表
返回服务的所有备份列表。最近的备份在列表中排在最前面。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/backups |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有备份的组织的 ID。 |
| serviceId | uuid | 创建备份的服务 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | id |
| status | string | 备份状态：“完成”、“错误”、“进行中”。 |
| serviceId | string | 名称 |
| startedAt | date-time | 备份开始时间戳。ISO-8601。 |
| finishedAt | date-time | 备份完成时间戳。ISO-8601。仅适用于已完成的备份 |
| sizeInBytes | number | 备份大小（字节）。 |
| durationInSeconds | number | 执行备份所花费的时间（秒）。如果状态仍为 in_progress，则这是自备份开始到现在的时间（秒）。 |
| type | string | 备份类型（“full”或“incremental”）。 |
示例响应
{
"id": "uuid",
"status": "string",
"serviceId": "string",
"startedAt": "date-time",
"finishedAt": "date-time",
"sizeInBytes": 0,
"durationInSeconds": 0,
"type": "string"
}
获取备份详情
返回单个备份信息。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有备份的组织的 ID。 |
| serviceId | uuid | 创建备份的服务 ID。 |
| backupId | uuid | 请求的备份 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | id |
| status | string | 备份状态：“完成”、“错误”、“进行中”。 |
| serviceId | string | 名称 |
| startedAt | date-time | 备份开始时间戳。ISO-8601。 |
| finishedAt | date-time | 备份完成时间戳。ISO-8601。仅适用于已完成的备份 |
| sizeInBytes | number | 备份大小（字节）。 |
| durationInSeconds | number | 执行备份所花费的时间（秒）。如果状态仍为 in_progress，则这是自备份开始到现在的时间（秒）。 |
| type | string | 备份类型（“full”或“incremental”）。 |
示例响应
{
"id": "uuid",
"status": "string",
"serviceId": "string",
"startedAt": "date-time",
"finishedAt": "date-time",
"sizeInBytes": 0,
"durationInSeconds": 0,
"type": "string"
}
获取服务备份配置
返回服务备份配置。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 服务的 ID。 |
响应
响应 Schema
| 名称 | 类型 | 描述 |
|---|---|---|
| backupPeriodInHours | number | 每次备份之间的小时间隔。 |
| backupRetentionPeriodInHours | number | 备份可用的最短持续时间（小时）。 |
| backupStartTime | string | HH:MM格式，用于执行备份的时间（以 UTC 时区评估）。定义后，备份周期将重置为每 24 小时。 |
示例响应
{
"backupPeriodInHours": 0,
"backupRetentionPeriodInHours": 0,
"backupStartTime": "string"
}
更新服务备份配置
更新服务备份配置。需要 ADMIN 授权密钥角色。使用 null 值设置属性，将把属性重置为默认值。
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 拥有该服务的组织的 ID。 |
| serviceId | uuid | 服务的 ID。 |
请求体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| backupPeriodInHours | number | 每次备份之间的小时间隔。 |
| backupRetentionPeriodInHours | number | 备份可用的最短持续时间（小时）。 |
| backupStartTime | string | HH:MM格式，用于执行备份的时间（以 UTC 时区评估）。定义后，备份周期将重置为每 24 小时。 |
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| backupPeriodInHours | number | 每次备份之间的小时间隔。 |
| backupRetentionPeriodInHours | number | 备份可用的最短持续时间（小时）。 |
| backupStartTime | string | HH:MM格式，用于执行备份的时间（以 UTC 时区评估）。定义后，备份周期将重置为每 24 小时。 |
示例响应
{
"backupPeriodInHours": 0,
"backupRetentionPeriodInHours": 0,
"backupStartTime": "string"
}