DescribeSqlLogTask_数据库自治服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

流控信息

请求速率为60/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hdm:DescribeSqlLogTask
Get
全部资源
*

请求参数

字段名称字段详情
InstanceIdstring

数据库实例 ID。

示例值:r-bp1nti25tc7bq5**** 参考取值来源:
    AddHDMInstance
    GetInstanceInspections
    CreateKillInstanceSessionTask
TaskIdstring

任务 ID。

示例值:a4f5c4494dbd6713185d87a97aa53e8
PageNointeger<int32>

分页查询的页码,从 1 开始,默认为 1。

示例值:1
PageSizeinteger<int32>

分页查询每页最大记录数,最大支持 100,默认为 10。

示例值:10

返回参数

字段名称字段详情
Codestring

返回的状态码。

示例值:200
Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

请求 ID。

示例值:B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:展开详情

示例值:true
Dataobject

返回数据。

返回说明

Key 支持的参数和取值:

  • KeyWords:关键字,多个关键字间使用空格隔开。
  • LogicalOperator:关键字间的逻辑操作,取值为 and 或 or。
  • AccountName:用户名,可以传递多个的,用逗号分开,上限为 5。
  • dbName:数据库名称,可以传递多个的,用逗号分开,上限为 5。
  • HostAddress:客户端 IP 地址,可以传递多个的,用逗号分开,上限为 5。
  • MaxConsume:最大耗时,单位 us。
  • MinConsume:最小耗时,单位 us。
  • MaxScanRows:最大扫描行。
  • MinScanRows:最小扫描行。
  • SqlType:SQL 类型,取值 select、update、insert 或 delete。
  • State:执行结果,取值 0(成功)或 1(失败)。
  • ThreadId:线程 ID。
  • SortKey:排序列名称,取值 ScanRows(扫描行数)、UpdateRows(更新行数)、Consume(耗时)、ExecuteTime(执行时间)、ReturnRows(返回行数)、LockTime(锁等待时间)、Frows(PolarDB-X 2.0 计算节点的拉取行数)、Scnt(PolarDB-X 2.0 计算节点的 DN 请求数)、CpuTime(CPU 执行时间)、PhysicalRead(物理读)。
  • SortMethod:排序方式,取值 DESC(降序)、ASC(升序)。默认为 DESC。
  • TraceId:PolarDB-X 2.0 实例的跟踪 ID。
  • MinRows:最小更新行数。
  • MaxRows:最大更新行数。
  • MinScnt:PolarDB-X 2.0 计算节点(CN)的 DN 最小请求数。
  • MaxScnt:PolarDB-X 2.0 计算节点(CN)的 DN 最大请求数。
  • TrxId:事务 ID。
  • Fail:错误码。
  • SqlId:SQL ID。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParams
The request parameters are invalid.诊断
403
NoPermission
You are not authorized to do this action.诊断

变更历史

变更时间变更内容概要操作
2025-04-01
变更返回参数
2024-07-03
变更返回参数
2024-05-22
变更返回参数

相关示例