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

请求参数

名称 类型 是否必选 示例值 描述
Action String CheckScaleOutBalanced

系统规定参数。取值:CheckScaleOutBalanced

RegionId String cn-hangzhou

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

DBClusterId String cc-bp108z124a8o7****

集群ID。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页数。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

总记录数。

TableDetails Array of TableDetail

检测失败信息。

TableDetail
TableName String test

本地表名。

Cluster String default

集群,唯一取值为default

Database String db_name

数据库名称。

Detail Integer 1

异常内容,取值说明:

  • 1:缺失唯一的分布式表。
  • 2:对应的分布式表不唯一。
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

请求ID。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页数。

CheckCode String 400

检测结果,取值说明:

  • 400:检测失败。
  • 200:检测成功。
TimeDuration String 21

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

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=CheckScaleOutBalanced
&RegionId=cn-hangzhou
&DBClusterId=cc-bp108z124a8o7****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckScaleOutBalancedResponse>
    <TotalCount>1</TotalCount>
    <TableDetails>
        <TableName>test</TableName>
        <Cluster>default</Cluster>
        <Database>db_name</Database>
        <Detail>1</Detail>
    </TableDetails>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <CheckCode>400</CheckCode>
    <TimeDuration>21</TimeDuration>
</CheckScaleOutBalancedResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An error occurred while processing your request. 系统内部错误,请稍后重试
503 ServiceUnavailable An error occurred while processing your request. 系统暂时不可用,请稍后重试

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