查询 SQL 详细信息,包括 SQL 文本、涉及的表名等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
oceanbase:DescribeOasSQLDetails |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
Oceanbase 集群 ID。 |
ob317v4uif**** |
| TenantId |
string |
是 |
租户 ID。 |
t4louaeei**** |
| SqlId |
string |
是 |
SQL ID。 |
8D6E84****0B8FB1823D199E2CA1**** |
| DbName |
string |
是 |
数据库名称。 |
test_db |
| StartTime |
string |
是 |
查询 SQL 执行计划的起始时间。 该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 |
2023-04-12T04:38:38Z |
| EndTime |
string |
是 |
查询 SQL 执行计划的结束时间。 该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 |
2023-04-12T05:38:38Z |
| DynamicSql |
boolean |
否 |
是否为动态 SQL。 |
false |
| ParseTable |
boolean |
否 |
是否解析表结构 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
请求的返回结果。 |
||
| RequestId |
string |
请求 ID。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Data |
object |
SQL 执行计划信息列表。 |
|
| Fulltext |
string |
由于脱敏,内容与参数 statement 一致。 |
select * from test where id = ? |
| Tables |
array |
SQL 涉及的表名。 |
|
|
string |
表名。 |
[{"xxxx","xxxx","xxxx"},{...}...] |
|
| UserName |
string |
用户名称。 |
test_user |
| Statement |
string |
参数化后的文本。 |
select * from test where id = ? |
| DbName |
string |
数据库名称。 |
test_db |
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": {
"Fulltext": "select * from test where id = ?",
"Tables": [
"[{\"xxxx\",\"xxxx\",\"xxxx\"},{...}...]"
],
"UserName": "test_user",
"Statement": "select * from test where id = ?",
"DbName": "test_db"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。