GetFullRequestStatResultByInstanceId によるフルリクエスト統計の非同期収集 - DAS

SQL ID を使用して、データベースインスタンスの SQL Explorer の結果からフルリクエスト統計を非同期で収集します。

操作説明

説明

GetFullRequestStatResultByInstanceId は非同期操作です。リクエストが送信されても、完全な結果はすぐに返されません。応答の isFinish パラメーターの値が false の場合は、1 秒待ってから再度リクエストを送信してください。isFinish パラメーターの値が true の場合は、完全な結果が返されます。

SQL Explorer 機能を使用すると、SQL ステートメントの稼働状況を確認し、パフォーマンスの問題をトラブルシューティングできます。詳細については、「SQL Explorer」をご参照ください。

この機能をサポートするデータベースインスタンスの詳細については、「DAS Enterprise Edition の概要」をご参照ください。
SDK を使用して Database Autonomy Service (DAS) の API オペレーションを呼び出す場合は、リージョン ID を cn-shanghai に設定する必要があります。
このオペレーションを呼び出す際、2024 年 9 月 1 日から SQL テンプレートアルゴリズムの最適化により SqlId パラメーターの値が変更されます。詳細については、「[お知らせ] SQL テンプレートアルゴリズムの最適化」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:GetFullRequestStatResultByInstanceId

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	任意	データベースインスタンスの作成に使用された Alibaba Cloud アカウント ID。説明このパラメーターはオプションです。GetFullRequestOriginStatByInstanceId オペレーションを呼び出す際、システムは InstanceId の値に基づいて Alibaba Cloud アカウント ID を自動的に取得できます。	196278346919****
InstanceId	string	必須	インスタンス ID。	rm-2ze8g2am97624****
NodeId	string	任意	ノード ID。説明データベースインスタンスが PolarDB for MySQL クラスターである場合は、ノード ID を指定する必要があります。	pi-bp12v7243x012****
SqlId	string	任意	SQL ID。説明このパラメーターが指定されている場合、指定された SQL クエリのフルリクエスト統計が収集されます。このパラメーターが空の場合、データベースインスタンス全体のフルリクエスト統計が収集されます。	d71f82be1eef72bd105128204d2e****
OriginHost	string	任意	SQL ステートメントを実行するクライアントの IP アドレス。説明このパラメーターはオプションです。このパラメーターが指定されている場合、指定された IP アドレスのフルリクエスト統計が収集されます。このパラメーターが空の場合、データベースインスタンス全体のフルリクエスト統計が収集されます。	172.26.XX.XXX
Keyword	string	任意	クエリに使用されるキーワード。	dbtest01
Start	integer	必須	クエリする時間範囲の開始時刻。このパラメーターは、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプに設定します。説明開始時刻は、現在時刻より最大 90 日前まで指定できます。	1645581813000
End	integer	必須	クエリする時間範囲の終了時刻。このパラメーターは、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプに設定します。説明終了時刻は開始時刻より後である必要があります。間隔は 1 日を超えることはできません。	1645668213000
OrderBy	string	任意	返されるエントリをソートするフィールド。デフォルト値: count。有効な値: count: 実行回数。 avgRt: 平均実行時間。 rtRate: 実行時間割合。 rowsExamined: スキャンされた行の合計数。 avgRowsExamined: スキャンされた行の平均数。 avgRowsReturned: 返された行の平均数。	count
Asc	boolean	任意	結果を昇順でソートするかどうかを指定します。デフォルトでは、結果は昇順でソートされません。	关闭
PageNo	integer	必須	ページ番号。ページは 1 から始まります。デフォルト値: 1。	1
PageSize	integer	必須	1 ページあたりのエントリ数。デフォルト値: 20。	20
SqlType	string	任意	SQL ステートメントのタイプ。有効な値: SELECT、INSERT、UPDATE、DELETE、LOGIN、LOGOUT、MERGE、ALTER、CREATEINDEX、DROPINDEX、CREATE、DROP、SET、DESC、REPLACE、CALL、BEGIN、DESCRIBE、ROLLBACK、FLUSH、USE、SHOW、START、COMMIT、および RENAME。説明データベースインスタンスが ApsaraDB RDS for MySQL インスタンス、PolarDB for MySQL クラスター、または PolarDB-X 2.0 インスタンスである場合、SQL ステートメントのタイプに基づいて統計を収集できます。	SELECT
DbName	string	任意	データベース名。	dbtest01
Role	string	任意	PolarDB-X 2.0 インスタンスにおけるノードのロール。有効な値: polarx_cn: 計算ノード。 polarx_dn: データノード。	polarx_cn

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Message	string	返されたメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどの情報を含むエラーメッセージが返されます。	Successful
RequestId	string	リクエスト ID。	7172BECE-588A-5961-8126-C216E16B****
Data	object	返されたデータ。
Result	object	返されたフルリクエストデータ。
List	array<object>	フルリクエストデータ。
	object
SqlId	string	SQL ID。	d71f82be1eef72bd105128204d2e****
AvgFetchRows	integer	PolarDB-X 2.0 インスタンスの計算ノードがデータノードからフェッチする行の平均数。	0
AvgLockWaitTime	number	平均ロック待機時間。単位: 秒。	0.00009589874265269765
AvgLogicalRead	number	論理読み込みの平均数。	654.4470327860251
AvgPhysicalAsyncRead	integer	物理非同期読み込みの平均数。	0
AvgPhysicalSyncRead	integer	物理同期読み込みの平均数。	0
AvgExaminedRows	number	スキャンされた行の平均数。説明このパラメーターは、ApsaraDB RDS for MySQL、ApsaraDB RDS for PostgreSQL、および PolarDB for MySQL データベースでのみ返されます。	10000
AvgReturnedRows	number	返された行の平均数。	10000
AvgUpdatedRows	integer	更新された行の平均数。説明このパラメーターは、ApsaraDB RDS for MySQL および PolarDB-X 2.0 データベースでのみ返されます。	10000
AvgRt	number	平均実行時間。	2.499
AvgSqlCount	integer	SQL ステートメントの平均数。	10000
Count	integer	実行回数の合計。	100000
CountRate	number	実行回数の合計に対する割合。	0.0586
Database	string	データベース名。	dbtest01
ErrorCount	integer	失敗した実行回数。	1
FetchRows	integer	PolarDB-X 2.0 インスタンスの計算ノードがデータノードからフェッチする行数。	0
Ip	string	データベースインスタンスの IP アドレス。	rm-uf6dyi58dm6**.mysql.rds.aliy**.com
LockWaitTime	number	ロック待機時間。単位: 秒。	1089.4177720290281
LogicalRead	integer	論理読み込み数。	7.434573266E9
PhysicalAsyncRead	integer	物理非同期読み込み数。	0
PhysicalSyncRead	integer	物理同期読み込み数。	0
Port	integer	データベースインスタンスへの接続に使用されるポート番号。	3306
Psql	string	SQL テンプレート。	select * from dbtest01 where ****
Rows	integer	PolarDB-X 2.0 インスタンスの計算ノードによって更新または返された行の合計数。	0
ExaminedRows	integer	スキャンされた行の合計数。説明このパラメーターは、ApsaraDB RDS for MySQL、ApsaraDB RDS for PostgreSQL、および PolarDB for MySQL データベースでのみ返されます。	10000
RtGreaterThanOneSecondCount	integer	実行に 1 秒以上かかる SQL ステートメントの数。	20
RtRate	number	実行時間割合。	2.499
SqlCount	integer	SQL ステートメントの数。	200
SumUpdatedRows	integer	更新された行の合計数。	100
Tables	array	データベース内のテーブル名。
	string	データベース内のテーブル名。	tabletest01,tabletest02
Version	integer	バージョン番号。	1
VpcId	string	VPC ID。	vpc-2zentqj1sk4qmolci****
Total	integer	返されたエントリの合計数。	1
Fail	boolean	非同期リクエストが失敗したかどうかを示します。有効な値: true false	false
IsFinish	boolean	非同期リクエストが完了したかどうかを示します。有効な値: true false	true
ResultId	string	リクエスト ID。	9CB97BC4-6479-55D0-B9D0-EA925AFE****
State	string	非同期リクエストの状態。有効な値: RUNNING SUCCESS FAIL	SUCCESS
Timestamp	integer	非同期リクエストが送信された時刻。値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	1645668213000
Code	integer	返された HTTP ステータスコード。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値: true false	true

例

成功レスポンス

JSONJSON

{
  "Message": "Successful",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Data": {
    "Result": {
      "List": [
        {
          "SqlId": "d71f82be1eef72bd105128204d2e****",
          "AvgFetchRows": 0,
          "AvgLockWaitTime": 0.00009589874265269765,
          "AvgLogicalRead": 654.4470327860251,
          "AvgPhysicalAsyncRead": 0,
          "AvgPhysicalSyncRead": 0,
          "AvgExaminedRows": 10000,
          "AvgReturnedRows": 10000,
          "AvgUpdatedRows": 10000,
          "AvgRt": 2.499,
          "AvgSqlCount": 10000,
          "Count": 100000,
          "CountRate": 0.0586,
          "Database": "dbtest01",
          "ErrorCount": 1,
          "FetchRows": 0,
          "Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
          "LockWaitTime": 1089.4177720290281,
          "LogicalRead": 7434573266,
          "PhysicalAsyncRead": 0,
          "PhysicalSyncRead": 0,
          "Port": 3306,
          "Psql": "select * from dbtest01 where ****",
          "Rows": 0,
          "ExaminedRows": 10000,
          "RtGreaterThanOneSecondCount": 20,
          "RtRate": 2.499,
          "SqlCount": 200,
          "SumUpdatedRows": 100,
          "Tables": [
            "tabletest01,tabletest02"
          ],
          "Version": 1,
          "VpcId": "vpc-2zentqj1sk4qmolci****"
        }
      ],
      "Total": 1
    },
    "Fail": false,
    "IsFinish": true,
    "ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
    "State": "SUCCESS",
    "Timestamp": 1645668213000
  },
  "Code": 200,
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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