CheckScaleOutBalanced - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Checks whether a specified ApsaraDB for ClickHouse cluster can be scaled out.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:CheckScaleOutBalanced

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call the DescribeRegions operation to query the region ID.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
PageSize	integer	No	The number of entries per page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	1
TableDetails	object
TableDetail	array<object>	The details of the failed check.
	object
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 details of the exception. Valid values: 1: The unique distributed table is missing. 2: The corresponding distributed table is not unique.	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 page number.	1
CheckCode	string	The result of the check. Valid values: 400: The check failed. 200: The check is successful.	400
TimeDuration	string	The time required for the scale-out migration, in minutes.	21

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.