DescribeDBClusterPerformance API によるパフォーマンスデータのクエリ - AnalyticDB

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

操作説明

サービスエンドポイントについては、「エンドポイント」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeDBClusterPerformance

list

*DBClusterLakeVersion

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	Data Lakehouse Edition クラスターの ID。説明ターゲットリージョン内のすべてのクラスターの ID を表示するには、DescribeDBClusters 操作を呼び出します。	amv-bp1hx5n1o8f61****
Key	string	任意	照会するパフォーマンスメトリクスのキー。複数のキーはカンマ (,) で区切ります。サポートされているメトリクスの詳細については、「メトリクス概要」をご参照ください。	AnalyticDB_CPU_Usage_Percentage
StartTime	string	任意	照会する期間の開始時刻。時刻は yyyy-MM-ddTHH:mmZ フォーマットで指定します。時刻は協定世界時 (UTC) である必要があります。	2022-03-10T23:56Z
EndTime	string	任意	照会する期間の終了時刻。時刻は yyyy-MM-ddTHH:mmZ フォーマットで指定します。時刻は協定世界時 (UTC) である必要があります。説明終了時刻は開始時刻より後である必要があります。期間は 2 日を超えることはできません。	2022-03-11T15:01Z
RegionId	string	必須	リージョン ID。説明 AnalyticDB for MySQL でサポートされているリージョンとゾーンに関する情報 (リージョン ID を含む) を照会するには、DescribeRegions 操作を呼び出します。	cn-hangzhou
ResourcePools	string	任意	リソースグループ。	user_default

レスポンスフィールド

フィールド	型	説明	例
	object
EndTime	string	照会された期間の終了時刻。時刻は yyyy-MM-ddTHH:mmZ フォーマットで、協定世界時 (UTC) で表示されます。	2022-03-11T15:01Z
RequestId	string	リクエスト ID。	BD8C3096-8BC6-51DF-A4AB-BACD9DC10435
StartTime	string	照会された期間の開始時刻。時刻は yyyy-MM-ddTHH:mmZ フォーマットで、協定世界時 (UTC) で表示されます。	2022-03-10T23:56Z
DBClusterId	string	クラスター ID。説明特定のリージョン内のすべてのクラスターの ID を照会するには、DescribeDBClusters 操作を呼び出します。	amv-bp1hx5n1o8f61****
Performances	array<object>	クラスターのパフォーマンスメトリクスリスト。
	array<object>	リスト。
Key	string	パフォーマンスメトリックの名前。	AnalyticDB_CPU_Usage_Percentage
Unit	string	メトリックの単位。	%
Series	array<object>	パフォーマンスデータのリスト。
	object	リスト。
Values	array	異なる時点でのパフォーマンス値の詳細。
	string	異なる時点でのパフォーマンス値の詳細。	[ [ "2023-06-27T13:21:00+08:00","0.1250" ], [ "2022-03-11T10:00:42.739Z","0.3125" ]... ]
Name	string	パフォーマンスメトリックの名前。これはモニタリングメトリックの値の名前です。詳細については、「メトリクス概要」をご参照ください。	AnalyticDB_Storage_CPU_Avg_Usage_Percentage
Tags	string	タグ値。	{instance_name: "am-***"}
TranslateKey	string

例

成功レスポンス

JSONJSON

{
  "EndTime": "2022-03-11T15:01Z",
  "RequestId": "BD8C3096-8BC6-51DF-A4AB-BACD9DC10435",
  "StartTime": "2022-03-10T23:56Z",
  "DBClusterId": "amv-bp1hx5n1o8f61****",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU_Usage_Percentage",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[\n  [ \n  \"2023-06-27T13:21:00+08:00\",\"0.1250\" \n  ], \n  [ \n  \"2022-03-11T10:00:42.739Z\",\"0.3125\" \n  ]...\n]"
          ],
          "Name": "AnalyticDB_Storage_CPU_Avg_Usage_Percentage",
          "Tags": "\n{instance_name: \"am-***\"}",
          "TranslateKey": ""
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

変更履歴

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