Checks whether an ApsaraDB for ClickHouse cluster is ready for a scale-out operation that is performed across clusters.

Request parameters

Parameter Type Required Example Description
Action String Yes CheckScaleOutBalanced

The operation that you want to perform. Set the value to CheckScaleOutBalanced.

RegionId String Yes cn-hangzhou

The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list.

DBClusterId String Yes cc-bp108z124a8o7****

The ID of the cluster.

PageSize Integer No 30

The number of entries to return on each page. Default value: 30. Valid values:

  • 30
  • 50
  • 100
PageNumber Integer No 1

The number of the page to return.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of entries returned.

TableDetails Array of TableDetail

The error information returned for a check failure.

TableDetail
TableName String test

The name of the local table.

Cluster String default

The cluster. The value is fixed at default.

Database String db_name

The name of the database in which the local table is stored.

Detail Integer 1

The error details. Valid values:

  • 1: The unique distributed table is missing.
  • 2: More than one distributed table exists for the local table.
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

The ID of the request.

PageSize Integer 30

The number of entries returned per page. Default value: 30. Valid values:

  • 30
  • 50
  • 100
PageNumber Integer 1

The page number of the returned page.

CheckCode String 400

The check result. Valid values:

  • 400: The cluster failed the check.
  • 200: The cluster passed the check.
TimeDuration String 21

The amount of time that is required for the scale-out operation. Unit: minutes.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=CheckScaleOutBalanced
&RegionId=cn-hangzhou
&DBClusterId=cc-bp108z124a8o7****
&<Common request parameters>

Sample success responses

XML format 

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 format 

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
}

Error codes

HttpCode Error codes Error message Description
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later.
503 ServiceUnavailable An error occurred while processing your request. The error message returned because the service is unavailable. Try again later.

For a list of error codes, visit the API Error Center.