機能の概要
このAPIは、指定された期間とベースライン期間において、指定されたOB Cloudデータベースインスタンスおよびテナントで実行されたTop SQLのパフォーマンスデータを比較するために使用されます。比較により、SQL実行パフォーマンスの変化傾向を特定し、パフォーマンス分析と最適化を支援します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIへのアクセスキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/topSqlComparision
リクエストパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
| requestId | string | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
| startTime | string | はい | 比較対象のターゲット期間の開始時刻(UTC形式)。 | 2026-02-25 15:40:43+00:00 |
| endTime | string | はい | 比較対象のターゲット期間の終了時刻(UTC形式)。 | 2026-02-26 10:40:43+00:00 |
| baseLineStartTime | string | はい | 比較ベースとなるベースライン期間の開始時刻(UTC形式)。 | 2026-02-24 15:40:43+00:00 |
| baseLineEndTime | string | はい | 比較ベースとなるベースライン期間の終了時刻(UTC形式)。 | 2026-02-25 10:40:43+00:00 |
| server | string | いいえ | サーバーアドレス。 | xxx.xxx.x.xxx:xxxx |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | object | 比較結果データオブジェクト。 |
| data.comparisionList | array | SQL比較結果リスト。 |
| data.comparisionList[].sqlId | string | SQLの一意の識別子ID。 |
| data.comparisionList[].sqlText | string | SQLテキスト。 |
| data.comparisionList[].executions | integer | ターゲット期間内の実行回数。 |
| data.comparisionList[].baselineExecutions | integer | ベースライン期間内の実行回数。 |
| data.comparisionList[].avgElapsedTime | number | ターゲット期間内の平均実行時間(単位：マイクロ秒)。 |
| data.comparisionList[].baselineAvgElapsedTime | number | ベースライン期間内の平均実行時間(単位：マイクロ秒)。 |
| data.comparisionList[].elapsedTimeChange | number | 平均実行時間の変化量（目標値 - ベースライン値）。 |
| data.comparisionList[].elapsedTimeChangeRate | number | 平均実行時間の変化率((目標値 - ベースライン値) / ベースライン値)。 |
| data.comparisionList[].avgCpuTime | number | 対象期間内の平均CPU時間（単位：マイクロ秒）。 |
| data.comparisionList[].baselineAvgCpuTime | number | ベースライン期間内の平均CPU時間（単位：マイクロ秒）。 |
| data.comparisionList[].cpuTimeChange | number | 平均CPU時間の変化量（目標値 - ベースライン値）。 |
| data.comparisionList[].cpuTimeChangeRate | number | 平均CPU時間の変化率((目標値 - ベースライン値) / ベースライン値)。 |
| data.comparisionList[].avgDiskReads | number | 対象期間内の平均ディスク読み取り回数。 |
| data.comparisionList[].baselineAvgDiskReads | number | ベースライン期間内の平均ディスク読み取り回数。 |
| data.comparisionList[].diskReadsChange | number | 平均ディスク読み取り回数の変化量（目標値 - ベースライン値）。 |
| data.comparisionList[].diskReadsChangeRate | number | 平均ディスク読み取り回数の変化率((目標値 - ベースライン値) / ベースライン値)。 |
| data.comparisionList[].server | string | このSQLを実行したサーバーアドレス。 |
| requestId | string | リクエストID。入力パラメータと一致します。 |
| success | boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl -X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/topSqlComparision?requestId={requestId}&startTime={startTime}&endTime={endTime}&baseLineStartTime={baseLineStartTime}&baseLineEndTime={baseLineEndTime}&server={server}' \
-H 'Content-Type: application/json' \
-u '<Your AK:SK>'
レスポンス例
{
"data": {
"comparisionList": [
{
"sqlId": "xxxxxx",
"sqlText": "SELECT * FROM test_table WHERE id = ?",
"executions": 1500,
"baselineExecutions": 1200,
"avgElapsedTime": 123.45,
"baselineAvgElapsedTime": 100.00,
"elapsedTimeChange": 23.45,
"elapsedTimeChangeRate": 0.2345,
"avgCpuTime": 80.10,
"baselineAvgCpuTime": 70.00,
"cpuTimeChange": 10.10,
"cpuTimeChangeRate": 0.1443,
"avgDiskReads": 5.2,
"baselineAvgDiskReads": 4.0,
"diskReadsChange": 1.2,
"diskReadsChangeRate": 0.3,
"server": "xxx.xxx.x.xxx:xxxx"
}
]
},
"requestId": "xxxxxx",
"success": true
}