全部产品
Search
文档中心

云数据库 ClickHouse:CheckScaleOutBalanced - 扩容检查

更新时间:Dec 05, 2024

对指定云数据库ClickHouse集群进行迁移扩容检测。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
clickhouse:CheckScaleOutBalancedget
*DBCluster
acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou
DBClusterIdstring

集群 ID。

cc-bp108z124a8o7****
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页数。

1

返回参数

名称类型描述示例值
object
TotalCountinteger

总记录数。

1
TableDetailsarray<object>

检测失败信息。

TableDetailobject
TableNamestring

本地表名。

test
Clusterstring

集群,唯一取值为 default

default
Databasestring

数据库名称。

db_name
Detailinteger

异常内容,取值说明:

  • 1:缺失唯一的分布式表。
  • 2:对应的分布式表不唯一。
1
RequestIdstring

请求 ID。

F5178C10-1407-4987-9133-DE4DC9119F75
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页数。

1
CheckCodestring

检测结果,取值说明:

  • 400:检测失败。
  • 200:检测成功。
400
TimeDurationstring

迁移扩容所需要的时间。单位:分钟。

21

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "TableDetails": {
    "TableDetail": [
      {
        "TableName": "test",
        "Cluster": "default",
        "Database": "db_name",
        "Detail": 1
      }
    ]
  },
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageSize": 30,
  "PageNumber": 1,
  "CheckCode": "400",
  "TimeDuration": "21"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request.系统内部错误,请稍后重试
503ServiceUnavailableAn error occurred while processing your request.系统暂时不可用,请稍后重试

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情