すべてのプロダクト
Search

このプロダクト

    :DescribeDBClusterPerformance

    ドキュメントセンター

    :DescribeDBClusterPerformance

    最終更新日:Nov 03, 2025

    DescribeDBClusterPerformance 操作を呼び出して、ApsaraDB for ClickHouse Community-Compatible Edition クラスターのパフォーマンスデータを表示します。

    操作説明

    パフォーマンスメトリックに基づいて、指定された時間範囲内の指定されたクラスターのパフォーマンスモニタリングデータを表示できます。データは 30 秒ごとに収集されます。

    説明

    この操作は、2021 年 12 月 1 日より前に作成された ApsaraDB for ClickHouse Community-Compatible Edition クラスターのみをサポートします。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    cc-bp125e3uu94wo****
    Key

    string

    任意

    クエリするパフォーマンスメトリック。複数のメトリック名をコンマ (,) で区切ります。一度に最大 5 つのパフォーマンスメトリックをクエリできます。次のパフォーマンスメトリックがサポートされています:

    説明

    Key は必須です。

    • CPU:

      • CPU_USAGE: CPU 使用率。

    • メモリ:

      • MEM_USAGE: メモリ使用量。

      • MEM_USAGE_SIZE: メモリ使用量 (MB)。

    • ディスク:

      • DISK_USAGE: ディスク使用率。

      • DISK_USAGE_SIZE: ディスク使用量 (MB)。

      • IOPS: ディスクの 1 秒あたりの入出力操作 (IOPS)。

    • 接続:

      • CONN_USAGE: データベース接続の使用率。

      • CONN_USAGE_COUNT: データベース接続数。

    • 書き込み:

      • TPS: 1 秒あたりの書き込み行数 (TPS)。

      • INSERT_SIZE: 1 秒あたりの書き込みサイズ (MB)。

    • クエリ:

      • QPS: 1 秒あたりのクエリ数 (QPS)。

      • AVG_SEEK: ランダム SEEK 呼び出しの数。

    • 待機:

      • ZK_WAIT: ZooKeeper (ZK) の平均待機時間 (ms)。

      • IO_WAIT: 平均 I/O 待機時間 (ms)。

      • CPU_WAIT: 平均 CPU 待機時間 (ms)。

    MEM_USAGE
    StartTime

    string

    必須

    クエリする時間範囲の開始時刻。yyyy-MM-ddTHH:mmZ 形式で時刻を指定します。時刻は UTC である必要があります。

    2021-11-27T16:37Z
    EndTime

    string

    必須

    クエリする時間範囲の終了時刻。yyyy-MM-ddTHH:mmZ 形式で時刻を指定します。時刻は UTC である必要があります。

    説明

    終了時刻は開始時刻より後である必要があります。最大時間範囲は 32 日を超えることはできません。

    2021-11-27T16:38Z

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    EndTime

    string

    クエリされた時間範囲の終了時刻。時刻は yyyy-MM-ddTHH:mmZ 形式です。時刻は UTC です。

    2021-11-27T16:38Z
    RequestId

    string

    リクエスト ID。

    FE242962-6DA3-5FC8-9691-37B62A3210F7
    StartTime

    string

    クエリされた時間範囲の開始時刻。時刻は yyyy-MM-ddTHH:mmZ 形式です。時刻は UTC です。

    2021-11-27T16:37Z
    DBClusterId

    string

    クラスター ID。

    cc-bp125e3uu94wo****
    Performances

    array<object>

    クラスターのパフォーマンスメトリックのリスト。

    array<object>

    パフォーマンスメトリック。

    Key

    string

    パフォーマンスメトリックの名前。

    MEM_USAGE
    Unit

    string

    メトリックの単位。

    %
    Series

    array<object>

    メトリックの時系列データ。

    array<object>

    メトリック情報。

    Values

    array<object>

    データポイント。各データポイントは特定の時点に対応します。

    object

    メトリック値。

    Point

    array

    データポイント。

    string

    データポイントの詳細。タイムスタンプと値で構成されます。

    [ "2021-11-26T16:39:00Z","15.08" ]
    Name

    string

    時系列の名前。これは通常、ノード ID です。

    cc-bp125e3uu94wo1s0k16****
    Name

    string

    パフォーマンスメトリックの名前。

    mem_usage

    例

    成功レスポンス

    JSONJSON

    {
  "EndTime": "2021-11-27T16:38Z",
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7",
  "StartTime": "2021-11-27T16:37Z",
  "DBClusterId": "cc-bp125e3uu94wo****",
  "Performances": [
    {
      "Key": "MEM_USAGE",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[ \"2021-11-26T16:39:00Z\",\"15.08\" ]"
              ]
            }
          ],
          "Name": "cc-bp125e3uu94wo1s0k16****"
        }
      ],
      "Name": "mem_usage"
    }
  ]
}

    エラーコード

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

    変更履歴

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