调用DescribeOasSQLDetails查询SQL详细信息_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

查询 SQL 详细信息，包括 SQL 文本、涉及的表名等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeOasSQLDetails		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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

返回参数

名称	类型	描述	示例值
	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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-08-21

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：DynamicSql