文档

DescribeSampleSqlRawTexts - 查询采样SQL的原始文本

更新时间:

该接口用于查询采样 SQL 的原始文本。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

ob2mr3oae0****
StartTimestring

起始时间。

该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2023-04-12T04:38:38Z
EndTimestring

结束时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2023-04-12T05:38:38Z
DbNamestring

数据库名称。

test_db
SqlIdstring

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
TraceIdstring

执行查询的 traceId, 对应 Slow SQL 明细中的 traceId。

说明 并非所有 Slow SQL 的 traceId 都能查询到原始文本。
YB420A700EFB-00060D53E42D0C61-0-0
Limitstring

用于控制 SQL 返回行数。

20

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

数据列表信息。

SqlTextarray

SQL 语句。

string

SQL 语句。

{ "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C", "Data": { "SqlText": [ "\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\"" ] } }

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "SqlText": [
      "{\n  \"RequestId\": \"EE205C00-30E4-****-****-87E3A8A2AA0C\",\n  \"Data\": {\n    \"SqlText\": [\n      \"\\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\\"\"\n    ]\n  }\n}"
    ]
  }
}

错误码

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

  • 本页导读 (0)