機能説明
このAPIは、指定されたOB Cloudデータベースインスタンスとテナントの特定期間内の高リスクSQLステートメントを照会するために使用されます。時間範囲、データベース名、ノードIPなどのフィルター条件を設定することで、データベースのパフォーマンスや安定性に影響を与える可能性のあるSQLリスト(実行頻度が高すぎる、平均CPU時間が長すぎるなど)を取得できます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/highRiskSql
リクエストパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| 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 |
| dbName | string | いいえ | SQLをフィルタリングするためのデータベース名。 | なし |
| nodeIp | string | いいえ | SQLをフィルタリングするためのノードIP。 | なし |
| searchKeyWord | string | いいえ | SQLのキーワード。SQLテキストとの部分一致検索に使用されます。 | update |
| sqlTextLength | integer | いいえ | 戻されるSQLテキストの最大長。 | 65535 |
| sqlId | string | いいえ | SQLステートメントの一意の識別子。 | sql_123456789 |
| filterCondition | string | いいえ | カスタムフィルター条件。フィールドは@記号で参照します。例:@avgCpuTime > 20 and @executions > 100。 |
@avgCpuTime > 20 and @executions > 100 |
| httpServletRequest | unknown | はい | Http servlet requestパラメータ。 | なし |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| なし | unknown | インターフェースが返すJSONデータ構造は不明です。実際の応答に基づいて処理してください。 |
例
リクエスト例
curl -X GET \
-H "Content-Type: application/json" \
-u '<あなたのak:sk>' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/highRiskSql?requestId={requestId}&startTime={startTime}&endTime={endTime}&httpServletRequest={httpServletRequest}'
レスポンス例
{
"server": "xxx.xxx.x.xxx:xxxx",
"data": [],
"errorMessage": "",
"successful": true,
"timestamp": 1731234567890
}