DescribeOasTopSQLList - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

診断システムによって収集された 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeOasTopSQLList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスターの ID。	ob317v4uif****
TenantId	string	必須	テナント ID。	t4louaeei****
StartTime	string	必須	TOPSQL パラメーターをクエリする開始時刻。YYYY-MM-DDThh:mm:ssZ 形式の協定世界時 (UTC) を使用します。	2023-04-12T04:38:38Z
EndTime	string	必須	TOPSQL パラメーターをクエリする終了時刻。YYYY-MM-DDThh:mm:ssZ 形式の協定世界時 (UTC) を使用します。この時刻は、YYYY-MM-DDThh:mm:ssZ 形式の UTC のみをサポートします。	2023-04-12T05:38:38Z
DbName	string	任意	データベース名。	test_db
SearchKeyWord	string	任意	キーワードクエリ。	update
SearchParam	string	任意	パラメータークエリ。	cputime
SearchRule	string	任意	クエリルール。	>
SearchValue	string	任意	クエリ値。	0.01
SqlId	string	任意	SQL ID。	8D6E84**0B8FB1823D199E2CA1**
NodeIp	string	任意	ノード IP。	i-bp18l4****str4uk03
FilterCondition	string	任意	@ シンボルを使用してすべてのフィールドを参照します。利用可能なフィールドについては、「SQL パフォーマンス統計のクエリ」API によって返される列をご参照ください。	@avgCpuTime > 20 and @executions > 100
AcceptLanguage	string	任意	返される情報の言語： zh: 中国語 en: 英語	zh-CN
SqlTextLength	integer	任意	返される SQL テキストの最大長。	65535
DynamicSql	boolean	任意	SQL が動的かどうかを示します。説明指定された SQL ID が動的 SQL ステートメントに属するかどうかを指定します。	false
MergeDynamicSql	boolean	任意	応答で動的 SQL ステートメントをマージするかどうかを示します。説明 IN 句を含む SQL ステートメントの結果を集計するかどうかを指定します。	true
CustomColumns	string	任意	カスタムフィールドルール。@ シンボルを使用してすべてのフィールドを参照します。サポートされている演算子には `+、-、*、/` が含まれます。フィールド名は小文字で始まる必要があります。利用可能なフィールドについては、「SQL パフォーマンス統計のクエリ」API によって返される列をご参照ください。	@failCount/@executions

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストへの応答。
RequestId	string	リクエスト ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	TopSQL 情報のリスト。
	array<object>	TopSQL 情報。
Executions	integer	SQL の実行回数。	100
RpcCount	number	SQL RPC 呼び出しの総数。	100
RemotePlans	integer	リモート SQL の実行回数。	100
MissPlans	integer	SQL プランキャッシュのミス回数。	100
MaxElapsedTime	number	SQL の最大応答時間。	10000
TotalWaitTime	number	SQL 実行中の合計待機時間 (ミリ秒)。これは v$sql_audit.total_wait_time_micro (ミリ秒) に対応します。	100000
ExecPs	number	SQL の実行頻度。	0.31
MaxCpuTime	number	最大 CPU 時間 (ミリ秒)。	13641.9
CpuPercentage	number	CPU 使用率。	100.0
ClientIp	string	クライアント IP アドレス。	i-bp1db****38uemejio
UserName	string	ユーザー名。	test_user
DbName	string	データベース名。	test_db
RetCode4012Count	integer	期間中のエラーコード 4012 の発生回数。	0
RetCode4013Count	integer	期間中のエラーコード 4013 の発生回数。	0
RetCode5001Count	integer	期間中のエラーコード 5001 の発生回数。	0
RetCode5024Count	integer	期間中のエラーコード 5024 の発生回数。	0
RetCode5167Count	integer	期間中のエラーコード 5167 の発生回数。	0
RetCode5217Count	integer	期間中のエラーコード 5217 の発生回数。	0
RetCode6002Count	integer	期間中のエラーコード 6002 の発生回数。	0
FailPercentage	number	期間中のエラー率。	0.0
SumWaitTime	number	合計待機時間 (ミリ秒)。	9421.73
AvgWaitCount	number	平均待機回数。	0.0
AvgRpcCount	number	SQL RPC 呼び出しの平均回数。	8.0
LocalPlanPercentage	number	SQL ローカルプランの割合。	0.0
RemotePlanPercentage	number	SQL リモートプランの割合。	0.0
DistPlanPercentage	number	SQL 分散プランの割合。	100.0
SumElapsedTime	number	SQL の合計応答時間 (ミリ秒)。	11452126.36
AvgNetTime	number	期間中の平均ネットワーク転送時間 (ミリ秒)。	0.0
AvgExecutorRpcCount	number	リモート SQL の実行回数。これは v$sl_audit.executor_rpc に対応します。	0.0
MissPlanPercentage	number	SQL プランキャッシュミスの割合。	0.0
TableScanPercentage	number	全表スキャンの割合。	0.0
StrongConsistencyPercentage	number	強整合性読み取りの割合。	100.0
WeakConsistencyPercentage	number	弱整合性読み取りの割合。	0.0
MaxAffectedRows	number	影響を受けた行の最大数。	10000.0
MaxReturnRows	number	返された行の最大数。	0.0
MaxWaitTime	number	最大待機時間 (ミリ秒)。	3.4
MaxApplicationWaitTime	number	最大アプリケーション待機時間 (ミリ秒)。	0.0
MaxConcurrencyWaitTime	number	最大 I/O 待機時間 (ミリ秒)。	0.0
MaxUserIoWaitTime	number	期間中の最大 UserIO イベント待機時間 (ミリ秒)。	0.0
MaxDiskReads	number	最大ディスク読み取り回数。	0.0
AvgExpectedWorkerCount	number	期待される同時実行数。	3
AvgUsedWorkerCount	number	期間中に SQL が使用したスレッドの平均数。	3
SumLogicalReads	number	合計論理読み取り回数。	0.0
Server	string	OBServer。	i-bp1db1****8uemejio
ServerIp	string	OBServer の IP。	i-bp1db1****8uemejio
ServerPort	integer	OBServer のポート。	389
SqlTextShort	string	SQL テキスト (先頭 100 文字)。	delete /+ XXX PARALLEL(4) / fro
SqlType	string	SQL タイプ。	select
SqlId	string	SQL ID。	8D6E84**0B8FB1823D199E2CA1**
Inner	boolean	SQL が内部 SQL かどうかを示します。	false
WaitEvent	string	最も長い待機イベント。	none
AvgAffectedRows	number	影響を受けた行の平均数。	9978.75
AvgReturnRows	number	返された行の平均数。	0.0
AvgPartitionCount	number	期間中にアクセスされたパーティションの平均数。	1.0
FailCount	integer	実行エラーの数。	0
AvgWaitTime	number	平均待機時間 (ミリ秒)。	1442.49
AvgElapsedTime	number	期間中の平均応答時間 (ミリ秒)。	903.29
AvgCpuTime	number	平均 CPU 時間 (ミリ秒)。	1875.34
AvgNetWaitTime	number	平均ネットワーク時間 (ミリ秒)。	0.0
AvgQueueTime	number	平均キュー時間 (ミリ秒)。	0.01
AvgDecodeTime	number	平均解析時間 (ミリ秒)。	0.0
AvgGetPlanTime	number	実行計画の取得にかかる平均時間 (ミリ秒)。	0.0
AvgExecuteTime	number	平均 SQL 実行時間 (ミリ秒)。	1895.7
AvgApplicationWaitTime	number	平均アプリケーション待機時間 (ミリ秒)。	0.0
AvgConcurrencyWaitTime	number	平均同時実行待機時間 (ミリ秒)。	0.0
AvgUserIoWaitTime	number	平均ユーザー I/O 時間 (ミリ秒)。	0.0
AvgScheduleTime	number	平均スケジューリング時間 (ミリ秒)。	0.0
AvgRowCacheHit	number	行キャッシュヒットの平均数。	0.0
AvgBloomFilterCacheHit	number	ブルームフィルターキャッシュヒットの平均数。	0.0
AvgBlockCacheHit	number	ブロックキャッシュヒットの平均数。	0.0
AvgBlockIndexCacheHit	number	ブロックインデックスキャッシュヒットの平均数。	0.0
AvgDiskReads	number	期間中の物理読み取りの平均数。	0.0
RetryCount	integer	リトライ回数。	0
AvgMemstoreReadRows	number	Memstore 読み取り行の平均数。	0.0
AvgSsstoreReadRows	number	SSTable 読み取り行の平均数。	0.0
AvgLogicalReads	number	平均論理読み取り回数。	0.0
DynamicSql	boolean	SQL が動的かどうかを示します。	false
SqlList	array<object>	SQL ステートメントのリスト。説明このパラメーターは、mergeDynamicSql が true に設定され、クエリに IN 句が含まれている場合にのみ表示されます。
	object	リクエストへの応答。
Executions	integer	SQL の実行回数。	100
RpcCount	number	SQL RPC 呼び出しの総数。	100
RemotePlans	integer	リモート SQL の実行回数。	100
MissPlans	integer	SQL プランキャッシュのミス回数。	100
MaxElapsedTime	number	SQL の最大応答時間。	10000
TotalWaitTime	number	SQL 実行中の合計待機時間 (ミリ秒)。これは v$sql_audit.total_wait_time_micro (ミリ秒) に対応します。	100000
ExecPs	number	SQL の実行頻度。	0.31
MaxCpuTime	number	最大 CPU 時間。	13641.9
CpuPercentage	number	CPU 使用率。	100
ClientIp	string	クライアント IP アドレス。	127...*
UserName	string	ユーザー名。	test_user
DbName	string	データベース名。	test
RetCode4012Count	integer	エラーコード 4012 の発生回数。	0
RetCode4013Count	integer	エラーコード 4013 の発生回数。	0
RetCode5001Count	integer	エラーコード 5001 の発生回数。	0
RetCode5024Count	integer	エラーコード 5024 の発生回数。	0
RetCode5167Count	integer	エラーコード 5167 の発生回数。	0
RetCode5217Count	integer	エラーコード 5217 の発生回数。	0
RetCode6002Count	integer	エラーコード 6002 の発生回数。	0
FailPercentage	number	SQL 実行エラー率。	0
SumWaitTime	number	期間中の合計待機時間 (ミリ秒)。(waitTime、v$sql_audit.wait_time_micro に対応)	9421.73
AvgWaitCount	number	平均待機回数。	0
AvgRpcCount	number	SQL RPC 呼び出しの平均回数。	8
LocalPlanPercentage	number	SQL ローカルプランの割合。	0
RemotePlanPercentage	number	SQL リモートプランの割合。	0
DistPlanPercentage	number	SQL 分散プランの割合。	100
SumElapsedTime	number	SQL の合計応答時間 (ミリ秒)。	11452126.36
AvgNetTime	number	平均 SQL ネットワーク I/O 時間 (ミリ秒)。	0
AvgExecutorRpcCount	number	リモート SQL の実行回数。これは v$sl_audit.executor_rpc に対応します。	0
MissPlanPercentage	number	SQL プランキャッシュミスの割合。	0
TableScanPercentage	number	全表スキャンの割合。	0
StrongConsistencyPercentage	number	強整合性読み取りの割合。	100
WeakConsistencyPercentage	number	弱整合性読み取りの割合。	0
MaxAffectedRows	number	影響を受けた行の最大数。	10000
MaxReturnRows	number	返された行の最大数。	0
MaxWaitTime	number	最大待機時間 (ミリ秒)。	3.4
MaxApplicationWaitTime	number	最大アプリケーション待機時間 (ミリ秒)。	0
MaxConcurrencyWaitTime	number	最大同時実行待機時間 (ミリ秒)。	0
MaxUserIoWaitTime	number	最大 I/O 待機時間 (ミリ秒)。	0
MaxDiskReads	number	最大ディスク読み取り回数。	0
AvgExpectedWorkerCount	number	期待される同時実行数。	3
AvgUsedWorkerCount	number	期間中に SQL が使用したスレッドの平均数。	3
SumLogicalReads	number	合計論理読み取り回数。	0
Server	string	OBServer	i-bp1db1****8uemejio
ServerIp	string	OBServer IP	i-bp1db1****8uemejio
ServerPort	integer	OBServer のポート。	389
SqlTextShort	string	SQL テキスト (先頭 100 文字)。	delete /+ XXX PARALLEL(4) / fro
SqlType	string	SQL タイプ。	select
SqlId	string	SQL ID。	8D6E84**0B8FB1823D199E2CA1**
Inner	boolean	SQL が内部 SQL かどうかを示します。	false
WaitEvent	string	最も長い待機イベント。	none
AvgAffectedRows	number	影響を受けた行の平均数。	9978.75
AvgReturnRows	number	返された行の平均数。	0
AvgPartitionCount	number	アクセスされたパーティションの平均数。	1
FailCount	integer	実行エラーの数。	0
AvgWaitTime	number	平均待機時間 (ミリ秒)。	1442.49
AvgElapsedTime	number	平均応答時間 (ミリ秒)。	903.29
AvgCpuTime	number	平均 CPU 時間 (ミリ秒)。	1875.34
AvgNetWaitTime	number	平均ネットワーク時間 (ミリ秒)。	0
AvgQueueTime	number	平均キュー時間 (ミリ秒)。	0.01
AvgDecodeTime	number	平均解析時間 (ミリ秒)。	0
AvgGetPlanTime	number	実行計画の取得にかかる平均時間 (ミリ秒)。	0
AvgExecuteTime	number	平均 SQL 実行時間 (ミリ秒)。	1895.7
AvgApplicationWaitTime	number	平均アプリケーション待機時間 (ミリ秒)。	0
AvgConcurrencyWaitTime	number	平均同時実行待機時間 (ミリ秒)。	0
AvgUserIoWaitTime	number	平均ユーザー I/O 時間 (ミリ秒)。	0
AvgScheduleTime	number	平均スケジューリング時間 (ミリ秒)。	0
AvgRowCacheHit	number	行キャッシュヒットの平均数。	0
AvgBloomFilterCacheHit	number	ブルームフィルターキャッシュヒットの平均数。	0
AvgBlockCacheHit	number	ブロックキャッシュヒットの平均数。	0
AvgBlockIndexCacheHit	number	ブロックインデックスキャッシュヒットの平均数。	0
AvgDiskReads	number	ディスク読み取りの平均回数。	0
RetryCount	integer	リトライ回数。	2
AvgMemstoreReadRows	number	Memstore 読み取り行の平均数。	0
AvgSsstoreReadRows	number	SSTable 読み取り行の平均数。	0
AvgLogicalReads	number	平均論理読み取り回数。	0
AvgDbTime	number	平均データベース時間 (ミリ秒)。	100
SumDbTime	number	合計データベース時間 (ミリ秒)。	100
FormatSqlId	string	FormatSqlId
LastFailCode	integer	最後に失敗した実行のエラーコード。	-4012
AvgDbTime	number	平均データベース時間 (ミリ秒)。	100
SumDbTime	number	合計データベース時間 (ミリ秒)。	100
CustomColumns	object	カスタム列。
Expression	string	カスタム列の式。	@failCount/@executions
Value	string	式から計算された値。	0.0
ObDbId	integer	データベース ID。	11006111****4828
FormatSqlId	string	FormatSqlId

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "Executions": 100,
      "RpcCount": 100,
      "RemotePlans": 100,
      "MissPlans": 100,
      "MaxElapsedTime": 10000,
      "TotalWaitTime": 100000,
      "ExecPs": 0.31,
      "MaxCpuTime": 13641.9,
      "CpuPercentage": 100,
      "ClientIp": "i-bp1db****38uemejio",
      "UserName": "test_user",
      "DbName": "test_db",
      "RetCode4012Count": 0,
      "RetCode4013Count": 0,
      "RetCode5001Count": 0,
      "RetCode5024Count": 0,
      "RetCode5167Count": 0,
      "RetCode5217Count": 0,
      "RetCode6002Count": 0,
      "FailPercentage": 0,
      "SumWaitTime": 9421.73,
      "AvgWaitCount": 0,
      "AvgRpcCount": 8,
      "LocalPlanPercentage": 0,
      "RemotePlanPercentage": 0,
      "DistPlanPercentage": 100,
      "SumElapsedTime": 11452126.36,
      "AvgNetTime": 0,
      "AvgExecutorRpcCount": 0,
      "MissPlanPercentage": 0,
      "TableScanPercentage": 0,
      "StrongConsistencyPercentage": 100,
      "WeakConsistencyPercentage": 0,
      "MaxAffectedRows": 10000,
      "MaxReturnRows": 0,
      "MaxWaitTime": 3.4,
      "MaxApplicationWaitTime": 0,
      "MaxConcurrencyWaitTime": 0,
      "MaxUserIoWaitTime": 0,
      "MaxDiskReads": 0,
      "AvgExpectedWorkerCount": 3,
      "AvgUsedWorkerCount": 3,
      "SumLogicalReads": 0,
      "Server": "i-bp1db1****8uemejio",
      "ServerIp": "i-bp1db1****8uemejio",
      "ServerPort": 389,
      "SqlTextShort": "delete /*+ XXX PARALLEL(4) */ fro",
      "SqlType": "select ",
      "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
      "Inner": false,
      "WaitEvent": "none",
      "AvgAffectedRows": 9978.75,
      "AvgReturnRows": 0,
      "AvgPartitionCount": 1,
      "FailCount": 0,
      "AvgWaitTime": 1442.49,
      "AvgElapsedTime": 903.29,
      "AvgCpuTime": 1875.34,
      "AvgNetWaitTime": 0,
      "AvgQueueTime": 0.01,
      "AvgDecodeTime": 0,
      "AvgGetPlanTime": 0,
      "AvgExecuteTime": 1895.7,
      "AvgApplicationWaitTime": 0,
      "AvgConcurrencyWaitTime": 0,
      "AvgUserIoWaitTime": 0,
      "AvgScheduleTime": 0,
      "AvgRowCacheHit": 0,
      "AvgBloomFilterCacheHit": 0,
      "AvgBlockCacheHit": 0,
      "AvgBlockIndexCacheHit": 0,
      "AvgDiskReads": 0,
      "RetryCount": 0,
      "AvgMemstoreReadRows": 0,
      "AvgSsstoreReadRows": 0,
      "AvgLogicalReads": 0,
      "DynamicSql": false,
      "SqlList": [
        {
          "Executions": 100,
          "RpcCount": 100,
          "RemotePlans": 100,
          "MissPlans": 100,
          "MaxElapsedTime": 10000,
          "TotalWaitTime": 100000,
          "ExecPs": 0.31,
          "MaxCpuTime": 13641.9,
          "CpuPercentage": 100,
          "ClientIp": "127.*.*.*",
          "UserName": "test_user",
          "DbName": "test",
          "RetCode4012Count": 0,
          "RetCode4013Count": 0,
          "RetCode5001Count": 0,
          "RetCode5024Count": 0,
          "RetCode5167Count": 0,
          "RetCode5217Count": 0,
          "RetCode6002Count": 0,
          "FailPercentage": 0,
          "SumWaitTime": 9421.73,
          "AvgWaitCount": 0,
          "AvgRpcCount": 8,
          "LocalPlanPercentage": 0,
          "RemotePlanPercentage": 0,
          "DistPlanPercentage": 100,
          "SumElapsedTime": 11452126.36,
          "AvgNetTime": 0,
          "AvgExecutorRpcCount": 0,
          "MissPlanPercentage": 0,
          "TableScanPercentage": 0,
          "StrongConsistencyPercentage": 100,
          "WeakConsistencyPercentage": 0,
          "MaxAffectedRows": 10000,
          "MaxReturnRows": 0,
          "MaxWaitTime": 3.4,
          "MaxApplicationWaitTime": 0,
          "MaxConcurrencyWaitTime": 0,
          "MaxUserIoWaitTime": 0,
          "MaxDiskReads": 0,
          "AvgExpectedWorkerCount": 3,
          "AvgUsedWorkerCount": 3,
          "SumLogicalReads": 0,
          "Server": "i-bp1db1****8uemejio",
          "ServerIp": "i-bp1db1****8uemejio",
          "ServerPort": 389,
          "SqlTextShort": "delete /*+ XXX PARALLEL(4) */ fro",
          "SqlType": "select",
          "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
          "Inner": false,
          "WaitEvent": "none",
          "AvgAffectedRows": 9978.75,
          "AvgReturnRows": 0,
          "AvgPartitionCount": 1,
          "FailCount": 0,
          "AvgWaitTime": 1442.49,
          "AvgElapsedTime": 903.29,
          "AvgCpuTime": 1875.34,
          "AvgNetWaitTime": 0,
          "AvgQueueTime": 0.01,
          "AvgDecodeTime": 0,
          "AvgGetPlanTime": 0,
          "AvgExecuteTime": 1895.7,
          "AvgApplicationWaitTime": 0,
          "AvgConcurrencyWaitTime": 0,
          "AvgUserIoWaitTime": 0,
          "AvgScheduleTime": 0,
          "AvgRowCacheHit": 0,
          "AvgBloomFilterCacheHit": 0,
          "AvgBlockCacheHit": 0,
          "AvgBlockIndexCacheHit": 0,
          "AvgDiskReads": 0,
          "RetryCount": 2,
          "AvgMemstoreReadRows": 0,
          "AvgSsstoreReadRows": 0,
          "AvgLogicalReads": 0,
          "AvgDbTime": 100,
          "SumDbTime": 100,
          "FormatSqlId": ""
        }
      ],
      "LastFailCode": -4012,
      "AvgDbTime": 100,
      "SumDbTime": 100,
      "CustomColumns": {
        "Expression": "@failCount/@executions",
        "Value": "0.0"
      },
      "ObDbId": 0,
      "FormatSqlId": ""
    }
  ]
}

エラーコード

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

変更履歴

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