Use CheckModifyConfigNeedRestart to Avoid Unnecessary Restarts - ApsaraDB for ClickHouse - Alibaba Cloud - ApsaraDB for ClickHouse

Operation description

Note

该接口仅支持 2021 年 12 月 01 日之后创建的社区兼容版集群。

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:CheckModifyConfigNeedRestart

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. You can call the DescribeDBClusters operation to query the information of all clusters in the target region, including the cluster ID.	cc-bp1tm8zf130ew****
Config	string	Yes	The configuration parameters to change.	400 4096 debug 1000M 5368709120 201 4096 0 0 256 auto 100 1 1717986918

Response elements

Element	Type	Description	Example
	object	Schema of Response
NeedRestart	boolean	变更配置参数后是否重启。取值说明： true：重启。 false：不重启。	true
RequestId	string	请求 ID。	06798FEE-BEF2-5FAF-A30D-728973BBE97C

Examples

Success response

JSON format

{
  "NeedRestart": true,
  "RequestId": "06798FEE-BEF2-5FAF-A30D-728973BBE97C"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.