DescribeApplicationPerformance - PolarDB - Alibaba Cloud ドキュメントセンター

PolarDB AI アプリケーションパフォーマンスのクエリ実行

今すぐお試しください

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

get

*dbcluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	string	必須	アプリケーションクラスターの ID。	pa-**************
Key	string	必須	クエリ対象のパフォーマンスメトリクス。複数のメトリクスはコンマ (,) で区切ります。最大 5 つのパフォーマンスメトリクスを指定できます。	PolarDBSupabaseMemUsage
StartTime	string	必須	クエリの開始時間。時間は UTC の `yyyy-MM-ddTHH:mmZ` フォーマットで指定します。	2020-09-23T01:01Z
EndTime	string	必須	クエリの終了時間。時間は UTC の `yyyy-MM-ddTHH:mmZ` フォーマットで指定します。	2020-09-23T01:00Z
Interval	string	任意	パフォーマンスデータの粒度 (秒単位)。有効な値： 5 30 60 600 1800 3600 86400	5
Consumer	string	任意	コンシューマーの ID。	c-xxxxxxx
ConsumerGroup	string	任意	コンシューマーグループの ID。	cg-xxxxxx
ModelService	string	任意	モデルサービスの ID。	ms-xxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	パフォーマンスデータ。
PerformanceKeys	object	パフォーマンスメトリクス。
PerformanceItem	array<object>	パフォーマンスメトリクスのリスト。
	array<object>	パフォーマンスメトリックの詳細。
MetricName	string	パフォーマンスメトリックの名前。	mean_cpu_usage
Measurement	string	パフォーマンスメトリック。	PolarDBSupabaseMemUsage
Points	object	メトリックのデータポイント。
PerformanceItemValue	array<object>	メトリックのデータポイントのリスト。
	object	データポイント。
Value	string	データポイントの値。	42.38
Timestamp	integer	データポイントのタイムスタンプ。単位：ミリ秒。	1600822800000
ComponentId	string	コンポーネント ID。	pac-xxx
ComponentType	string	コンポーネントタイプ。	backend
EndTime	string	クエリの終了時刻。時刻は UTC で、`yyyy-MM-ddTHH:mm:ssZ` フォーマットです。	2025-05-23T02:21:00Z
RequestId	string	リクエスト ID。	CDB3258F-B5DE-43C4-8935-CBA0CA******
StartTime	string	クエリの開始時刻。時刻は UTC で、`yyyy-MM-ddTHH:mm:ssZ` フォーマットです。	2022-11-15T16:00Z
ApplicationId	string	アプリケーションクラスターの ID。	pa-**************
ApplicationType	string	アプリケーションタイプ。	supabase

例

成功レスポンス

JSONJSON

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_cpu_usage",
        "Measurement": "PolarDBSupabaseMemUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        },
        "ComponentId": "pac-xxx",
        "ComponentType": "backend"
      }
    ]
  },
  "EndTime": "2025-05-23T02:21:00Z",
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "StartTime": "2022-11-15T16:00Z",
  "ApplicationId": "pa-**************",
  "ApplicationType": "supabase"
}

エラーコード

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.

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

変更履歴

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