機能の概要
指定されたSQL IDに対する指定された期間内の元のSQLテキストサンプルリストを照会するために使用されます。このインターフェースは、特定のSQLステートメントの実行パターンの分析やSQL監査に利用できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/sampleSql
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
| sqlId | String | はい | SQLステートメントの一意の識別子 | sql_123456789 |
Query
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
| dbName | String | はい | データベース名 | testdb |
| startTime | String | はい | 開始時間(UTC) | 2026-02-25 15:40:43+00:00 |
| endTime | String | はい | 終了時間(UTC) | 2026-02-26 10:40:43+00:00 |
| dynamicSql | Boolean | いいえ | Dynamic sqlパラメータ | false |
| limit | Integer | はい | 結果数の上限 | 10 |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | SQLの元のテキストデータ |
| data.dataList | Array<Object> |
SQLテキストのリスト |
| data.dataList[].sqlText | Array |
SQLテキストの配列 |
| data.total | Integer | 合計数 |
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/sampleSql?requestId={requestId}&dbName={dbName}&startTime={startTime}&endTime={endTime}&limit={limit}' \
-G
レスポンス例
JSON形式
{
"data": {
"dataList": [
{
"sqlText": [
"SELECT * FROM in_table_0915 WHERE id IN ('1')"
]
}
],
"total": 1
},
"requestId": "136f85a2-5fac-4a0d-adf7-8735511ba28c",
"success": true
}