すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBClusterPerformance

    ドキュメントセンター

    PolarDB:DescribeDBClusterPerformance

    最終更新日:May 19, 2026

    PolarDB クラスターのパフォーマンスデータを照会します。

    操作説明

    • 監視頻度が 5 秒に 1 回の場合：

      • クエリ時間範囲が 1 時間以内の場合、データ粒度は 5 秒となります。

      • クエリ時間範囲が 1 日以内の場合、データ粒度は 1 分となります。

      • クエリ時間範囲が 7 日以内の場合、データ粒度は 10 分となります。

      • クエリ時間範囲が 30 日以内の場合、データ粒度は 1 時間となります。

      • クエリ時間範囲が 30 日を超える場合、データ粒度は 1 日となります。

    • 監視頻度が 60 秒に 1 回の場合：

      • クエリ時間範囲が 1 日以内の場合、データ粒度は 1 分となります。

      • クエリ時間範囲が 7 日以内の場合、データ粒度は 10 分となります。

      • クエリ時間範囲が 30 日以内の場合、データ粒度は 1 時間となります。

      • クエリ時間範囲が 30 日を超える場合、データ粒度は 1 日となります。

    説明

    デフォルトの監視頻度は 60 秒に 1 回です。監視頻度を 5 秒に 1 回に設定するには、ModifyDBClusterMonitor API を呼び出します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeDBClusterPerformance

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID です。

    pc-****************
    Type

    string

    任意

    クエリタイプ です。

    orca
    Key

    string

    必須

    照会するパフォーマンスメトリクス です。複数のメトリクスはコンマ (,) で区切ります。詳細については、「パフォーマンスパラメーター」をご参照ください。

    説明

    パフォーマンスメトリクスを最大 5 つまで指定します。

    PolarDBDiskUsage
    StartTime

    string

    必須

    照会する時間範囲の開始時刻です。時刻は yyyy-MM-ddTHH:mmZ フォーマットで指定します。時刻は UTC である必要があります。

    2020-09-23T01:01Z
    EndTime

    string

    必須

    照会する時間範囲の終了時刻です。時刻は yyyy-MM-ddTHH:mmZ フォーマットで指定します。時刻は UTC である必要があります。

    2020-09-23T01:00Z
    Interval

    string

    任意

    パフォーマンスデータの粒度。有効な値：

    • 5

    • 30

    • 60

    • 600

    • 1800

    • 3600

    • 86400

    60
    SubGroupName

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PerformanceKeys

    object

    PerformanceItem

    array<object>

    クラスターパフォーマンスデータのリストです。

    array<object>

    MetricName

    string

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

    mean_data_size
    Measurement

    string

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

    PolarDBDiskUsage
    Points

    object

    PerformanceItemValue

    array<object>

    パフォーマンスデータの配列です。

    object

    Value

    string

    モニタリングメトリックの値です。

    42.38
    Timestamp

    integer

    メトリックが収集された時点です。値は UNIX タイムスタンプです。単位：ミリ秒。

    1600822800000
    DBNodeId

    string

    データベースクラスターノードの ID です。

    説明

    Key パラメーターが PolarDBDiskUsage に設定されている場合、このパラメーターは返されません。

    pi-*************
    DBVersion

    string

    互換性のあるデータベースバージョンです。

    8.0
    EndTime

    string

    時間範囲の終了時刻です。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ フォーマットです。

    2020-09-23T01:01:00Z
    RequestId

    string

    リクエスト ID です。

    35D3E3DA-4650-407A-BFF5-59BFF1******
    StartTime

    string

    時間範囲の開始時刻です。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ フォーマットです。

    2020-09-23T01:00:00Z
    DBClusterId

    string

    データベースクラスター ID です。

    pc-*****************
    DBType

    string

    互換性のあるデータベースタイプです。

    MySQL

    例

    成功レスポンス

    JSONJSON

    {
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_data_size",
        "Measurement": "PolarDBDiskUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidKey.Malformed The specified parameter Key is not valid.
    400 InvalidEndTime.Malformed The specified parameter EndTime is not valid.
    400 InvalidStartTime.Malformed The specified parameter StartTime is not valid.
    400 InvalidParameterCombination The end time must be greater than the start time.
    400 InvalidDateRange.Malformed The Date Range can not more than one month.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

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

    変更履歴

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