DescribeOasSlowSQLList - SlowSQLリストのクエリ|OceanBase Cloud|ドキュメント|分散データベース

DescribeOasSlowSQLList - SlowSQLリストのクエリ

最終更新日：2026-07-31 06:58:55 更新

機能の概要

このAPIは、指定されたOceanBaseクラスタのテナントにおけるスローSQLのリストを照会するために使用されます。時間範囲、データベース、ノード、SQLキーワードなどの条件でフィルタリングが可能で、SQLの実行詳細とパフォーマンス統計データを返します。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。

リクエストパス

GET /api/v2/instances/{instanceId}/tenants/{tenantId}/slowSql

リクエストパラメータ

名前	型	必須	説明	サンプル値
instanceId	string	はい	OceanBase CloudデータベースインスタンスID。	ob317v4uif****
tenantId	string	はい	テナントID。	t4louaeei****
requestId	string	はい	追跡用のリクエストID。	dc302d76-66b5-48d8-ab53-a035********
startTime	string	はい	スローSQLパラメータの検索開始時刻。この時間はUTC時間のみサポートされ、形式はYYYY-MM-DDThh:mm:ssZです。	2023-04-12T04:38:38Z 説明時間入力パラメータの特殊文字（コロン(:)など）は、適宜エスケープしてください。例えば、2023-04-12T05:38:38ZをURLリクエストパラメータに含める場合、2023-04-12T04%3A38%3A38Zにエスケープする必要があります。
endTime	string	はい	スローSQLパラメータの検索終了時刻。この時間はUTC時間のみサポートされ、形式はYYYY-MM-DDThh:mm:ssZです。	2023-04-12T05:38:38Z 説明時間入力パラメータの特殊文字（コロン(:)など）は、適宜エスケープしてください。例えば、2023-04-12T05:38:38ZをURLリクエストパラメータに含める場合、2023-04-12T04%3A38%3A38Zにエスケープする必要があります。
dbName	string	いいえ	データベース名。	test_db
nodeIp	string	いいえ	ノードIP。	i-bp18l4****str4uk03
searchKeyWord	string	いいえ	キーワード検索。	update
sqlTextLength	integer	いいえ	戻されるSQLテキストの最大長。	65535
filterCondition	string	いいえ	すべてのフィールドは@で参照します。選択可能なフィールドについては、SQLのパフォーマンス統計のクエリインターフェースで返されるすべての列をご参照ください。	@avgCpuTime > 20 and @executions > 100
mergeDynamicSql	boolean	いいえ	動的SQLをマージするかどうか。	true
sqlId	string	いいえ	SQL文の一意の識別子。	sql_123456789
dynamicSql	boolean	いいえ	動的SQLかどうか。	false
httpServletRequest	unknown	はい	Http servlet requestパラメータ。	なし

戻り値

プロパティ	型	説明	サンプル値
	object	リクエストの実行結果。
Data	object []	スローSQL情報リスト。
executions	double	期間中の総実行回数。	1
rpcCount	double	期間中のRPC回数。	0.0
remotePlans	double	期間中のリモート実行回数。	0
missPlans	double	期間中にヒットしなかった実行計画の回数。	0
maxElapsedTime	double	期間中の最大応答時間。	13643.3
totalWaitTime	double	期間中の合計待機時間（ミリ秒単位）。	10.966
execPs	double	期間中の1秒あたりの平均実行回数。	0.31
maxCpuTime	double	最大CPU時間（ミリ秒単位）。	13641.9
cpuPercentage	double	CPU利用率。	100.0
userName	string	ユーザー名。	test_user
dbName	string	データベース名。	test_db
retCode4012Count	long	期間内の結果コード4012の発生回数。	0
retCode4013Count	long	期間内の結果コード4013の発生回数。	0
retCode5001Count	long	期間内の結果コード5001の発生回数。	0
retCode5024Count	long	期間内の結果コード5024の発生回数。	0
retCode5167Count	long	期間内の結果コード5167の発生回数。	0
retCode5217Count	long	期間内の結果コード5217の発生回数。	0
retCode6002Count	long	期間内の結果コード6002の発生回数。	0
failPercentage	double	期間内のエラー率。	0.0
sumWaitTime	double	期間内の合計待機時間（ミリ秒）。	9421.73
avgWaitCount	double	期間内の平均待機回数。	0.0
avgRpcCount	double	期間内の平均RPC送信回数。	8.0
localPlanPercentage	double	期間内のローカル計画の割合。	0.0
remotePlanPercentage	double	期間内のリモート計画の割合。	0.0
distPlanPercentage	double	期間内の分散計画の割合。	100.0
sumElapsedTime	double	期間内の合計応答時間（ミリ秒）。	11452126.36
avgNetTime	double	期間内の平均ネットワーク転送時間（ミリ秒）。	0.0
avgExecutorRpcCount	double	期間内の平均実行RPCリクエスト回数。	0.0
missPlanPercentage	double	期間内の計画ヒット率。	0.0
tableScanPercentage	double	期間内のテーブルスキャンの割合。	0.0
strongConsistencyPercentage	double	期間内の強整合性トランザクションの割合。	100.0
weakConsistencyPercentage	double	期間内の弱整合性トランザクションの割合。	0.0
maxAffectedRows	double	期間内の最大影響行数。	10000.0
maxReturnRows	double	期間内の最大返却行数。	0.0
maxWaitTime	double	期間内の最大待機時間（ミリ秒）。	3.4
maxApplicationWaitTime	double	期間内の最大 Application イベント待機時間（ミリ秒）。	0.0
maxConcurrencyWaitTime	double	期間内の最大 Concurrency イベント待機時間（ミリ秒）。	0.0
maxUserIoWaitTime	double	期間内の最大 UserIO イベント待機時間（ミリ秒）。	0.0
maxDiskReads	double	期間内の最大物理読み取り回数。	0.0
avgExpectedWorkerCount	double	期間内の平均並列度。	3
avgUsedWorkerCount	double	期間内のSQL平均使用スレッド数。	3
sumLogicalReads	double	期間内のSQL総論理読み取り。	0.0
server	string	SQL実行が行われたサーバー。	xxx.xxx.x.xxx:xxxx
serverIp	string	SQL実行が行われたサーバーIPアドレス。	i-bp1db1****8uemejio
serverPort	long	SQL実行サーバーのポート番号。	389
sqlTextShort	string	SQLのテキスト（最初の100文字）。	delete /+ XXX PARALLEL(4) / fro
sqlType	string	SQLタイプ。	select
sqlId	string	SQL ID。	8D6E84**0B8FB1823D199E2CA1**
inner	boolean	内部SQLかどうか。	false
waitEvent	string	期間内の最大待機イベント。	none
avgAffectedRows	double	期間内の平均更新行数。	9978.75
avgReturnRows	double	期間内の平均返却行数。	0.0
avgPartitionCount	double	期間内の平均アクセスパーティション数。	1.0
failCount	double	エラー回数。	0
avgWaitTime	double	期間内の平均待機時間（ミリ秒）。	1442.49
avgElapsedTime	double	期間内の平均応答時間（ミリ秒）。	903.29
avgCpuTime	double	期間内の平均CPU時間（ミリ秒）。	1875.34
avgNetWaitTime	double	期間内の平均ネットワーク待ち行列時間（ミリ秒）。	0.0
avgQueueTime	double	期間内の平均キュータイム（ミリ秒）。	0.01
avgDecodeTime	double	期間内の平均構文解析時間（ミリ秒）。	0.0
avgGetPlanTime	double	期間内の平均計画生成時間（ミリ秒）。	0.0
avgExecuteTime	double	期間内の平均計画実行時間（ミリ秒）。	1895.7
avgApplicationWaitTime	double	期間内の平均Applicationイベント待機時間（ミリ秒）。	0.0
avgConcurrencyWaitTime	double	期間内の平均Concurrencyイベント待機時間（ミリ秒）。	0.0
avgUserIoWaitTime	double	期間内の平均UserIOイベント待機時間（ミリ秒）。	0.0
avgScheduleTime	double	期間内の平均Scheduleイベント待機時間（ミリ秒）。	0.0
avgRowCacheHit	double	期間内の平均RowCacheヒット数。	0.0
avgBloomFilterCacheHit	double	期間内の平均BloomFilterCacheヒット数。	0.0
avgBlockCacheHit	double	期間内の平均BlockCacheヒット数。	0.0
avgBlockIndexCacheHit	double	期間内の平均BlockIndexCacheヒット数。	0.0
avgDiskReads	double	期間内の平均物理読み取り数。	0.0
retryCount	double	期間内の累計リトライ回数。	0
avgMemstoreReadRows	double	メモリから読んだ行数。	0.0
avgSsstoreReadRows	double	ディスクから読んだ行数。	0.0
avgLogicalReads	double	期間内のSQL平均論理読み取り数。	0.0

例

リクエスト例

curl --request GET \
  --digest -u '<Your AK:SK>' \
  -G -d 'requestId={requestId}' \
  -d 'startTime={startTime}' \
  -d 'endTime={endTime}' \
  -d 'dbName={dbName}' \
  --url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/slowSql' \
  -H 'X-Ob-Project-Id: <Project ID>'

注意

パラメータに特殊文字が含まれる場合は、エスケープする必要があります。例：-d'@avgCpuTime>0' を -d'%40avgCpuTime%3E0' に書き換えてください。時間を表すパラメータの特殊文字（コロン（:）など）は、必ず適切にエスケープしてください。
パラメータに特殊文字が含まれる場合は、エスケープする必要があります。例：-d'@avgCpuTime>0' を -d'%40avgCpuTime%3E0' に書き換えてください。時間を表すパラメータの特殊文字（コロン（:）など）は、必ず適切にエスケープしてください。
プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。

レスポンス例

JSON形式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "executions": 1,
      "rpcCount": 0,
      "remotePlans": 0,
      "missPlans": 0,
      "maxElapsedTime": 13643.3,
      "totalWaitTime": 10.966,
      "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": "xxx.xxx.x.xxx:xxxx",
      "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
    }
  ]
}

OceanBase

顧客事例