ModifyDBClusterConfigInXML - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Operation description

Note

This operation supports only community-compatible clusters created after December 1, 2021.

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

update

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The cluster ID. Call the DescribeDBClusters operation to query the IDs of all clusters in a region.

cc-bp108z124a8o7****

Config

string

Yes

The configuration parameters to modify. Call the DescribeDBClusterConfigInXML operation to query the current configuration parameters. Then, modify the returned parameters.

Note

When you modify a parameter, you must include all other configuration parameters in the request. If a parameter is not included, it retains its initial value or the modification fails.

debug 1000M 64 4096 300 100 0 10000 0.9 4194304 0 system

query_log

ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY 7500 system query_thread_log

ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY 7500 0 0 256 100 1 16 6871947673 3435973836

RegionId

string

No

The region ID. Call the DescribeRegions operation to query available region IDs.

cn-hangzhou

Reason

string

No

The reason for the modification.

test

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	BDD29EB1-BE76-5CFA-9068-D34B696310BF

Examples

Success response

JSON format

{
  "RequestId": "BDD29EB1-BE76-5CFA-9068-D34B696310BF"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.