すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for ClickHouse:CheckModifyConfigNeedRestart

最終更新日:Jun 26, 2026

ApsaraDB for ClickHouse Community 互換エディションクラスターにおいて、XML モードで構成パラメーターを変更する際に再起動が必要かどうかを確認します。

操作説明

説明

この操作は、2021 年 12 月 1 日以降に作成された Community 互換エディションクラスターのみをサポートしています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:CheckModifyConfigNeedRestart

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスター ID。 DescribeDBClusters 操作を呼び出して、指定されたリージョン内のすべてのクラスターの情報(クラスター ID を含む)をクエリできます。

cc-bp1tm8zf130ew****

Config

string

必須

変更済みの構成パラメーター。

400 4096 debug 1000M 5368709120 201 4096 0 0 256 auto 100 1 1717986918

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

NeedRestart

boolean

構成パラメーターが変更済みになった後に再起動が必須かどうかを示します。有効な値:

  • true: 再起動が必須です。

  • false: 再起動は必須ではありません。

true

RequestId

string

リクエスト ID。

06798FEE-BEF2-5FAF-A30D-728973BBE97C

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。