查询 SQL 的文本 - 云平台 OCP V4.3.0

查询 SQL 的文本

更新时间：2026-04-14 11:55:54

编辑

功能说明

查询指定 ID 的 SQL 的全文本。

调用说明

接口约束

调用者需具备指定租户的读权限。

请求路径

GET /api/v2/ob/clusters/{clusterId}/tenants/{tenantId}/sqls/{sqlId}/text

请求参数

参数	类型	必选	示例值	描述
clusterId	Integer	是	1	集群的 Id
tenantId	Integer	是	1001	租户的 Id
sqlId	String	是	C9B3A63AFF8F2A408CCF3D5B0F36682D	SQL的 Id
startTime	Datetime	是	2020-02-16T05:32:16+08:00	开始时间
endTime	Datetime	是	2020-02-16T07:32:16+08:00	结束时间

返回结果

基础数据结构

参数	类型	说明
data	Object	请求的数据。
├─ fulltext	String	SQL 的全文本。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
sqlId	String	SQL 的 Id。
statement	String	SQL 参数化后的文本。
supportOutline	Boolean	SQL 是否能绑定 outline, OBServer V2.2.70 以下的版本要求 select 后第一个字符必须为空格。
tables	String	SQL 里的表名。
userName	String	SQL 的用户。
dbName	String	数据库名。

示例

请求示例

查询集群 Id 为 1 、租户 Id 为 1001、SQL ID 为 C9B3A63AFF8F2A408CCF3D5B0F36682D 的文本。时间范围为 2020-11-03T19:00:00+08:00 ～ 2020-11-03T20:00。

GET /api/v2/ob/clusters/1/tenants/1001/C9B3A63AFF8F2A408CCF3D5B0F36682D/text?startTime=2020-11-03T19%3A00%3A00%2B08%3A00&endTime=2020-11-03T20%3A00%3A00%2B08%3A00

返回示例

{
    "duration": 23,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2020-11-03T21:14:53.216+08:00",
    "traceId": "60ff4f60c1e6454d",
    "data": {
        "fulltext": "SELECT 1 FROM DUAL"
    }   
}