すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:CheckScaleOutBalanced

    ドキュメントセンター

    ApsaraDB for ClickHouse:CheckScaleOutBalanced

    最終更新日:Jun 23, 2026

    指定されたApsaraDB for ClickHouseクラスターに対して、データ移行スケールアウトチェックを実行します。

    今すぐお試しください

    この 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:CheckScaleOutBalanced

    get

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョンID。 DescribeRegions を呼び出して、リージョンIDを照会できます。

    cn-hangzhou
    DBClusterId

    string

    必須

    クラスターID。

    cc-bp108z124a8o7****
    PageSize

    integer

    任意

    ページあたりのエントリ数。有効な値：

    • 30（デフォルト）

    • 50

    • 100。

    30
    PageNumber

    integer

    任意

    ページ番号。

    1
    ScalingType

    string

    任意

    仕様変更タイプ。有効な値：

    • ScaleOut：水平スケールアウト

    • ScaleIn：水平スケールイン

    • MultiAzUpgrade：マルチアクティブゾーンデプロイメントへのアップグレード

    • DiskDownGrade：クラウドディスクのダウングレード。

    ScaleOut

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    エントリの合計数。

    1
    TableDetails

    object

    TableDetail

    array<object>

    チェック失敗の情報。

    object

    TableName

    string

    ローカルテーブル名。

    test
    Cluster

    string

    クラスター。唯一の有効な値は デフォルト です。

    default
    Database

    string

    データベース名。

    db_name
    Detail

    integer

    例外の詳細。有効な値:

    • 1: 一意の分散テーブルが見つかりません。

    • 2: 対応する分散テーブルが一意ではありません。

    1
    RequestId

    string

    リクエストID。

    F5178C10-1407-4987-9133-DE4DC9119F75
    PageSize

    integer

    ページあたりのエントリ数。有効な値：

    • 30（デフォルト）

    • 50

    • 100。

    30
    PageNumber

    integer

    ページ番号。

    1
    CheckCode

    string

    チェック結果。有効な値：

    • 400：チェックに失敗しました。

    • 200：チェックに成功しました。

    400
    TimeDuration

    string

    データ移行スケールアウトに必要な時間。単位：分。

    21

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

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

    変更履歴

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