CheckScaleOutBalanced - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Performs migration and scale-out detection on an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
PageSize	integer	No	The number of entries returned per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The total number of returned pages.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries that are returned.	1
TableDetails	object []	The error information returned for a check failure.
TableName	string	The name of the local table.	test
Cluster	string	The cluster. The value is fixed as default.	default
Database	string	The database name.	db_name
Detail	integer	The error details. Valid values: 1: The unique distributed table is missing. 2: More than one distributed table exists for the local table.	1
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
PageSize	integer	The number of entries returned per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	The total number of returned pages.	1
CheckCode	string	The check result. Valid values: 400: The cluster failed the check. 200: The cluster passed the check.	400
TimeDuration	string	The amount of time that is required for the migration and scale-out. Unit: minutes.	21

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history