DescribeSqlLogTasks - 查询DAS企业版离线任务_数据库自治服务(DAS)-阿里云帮助中心

调用DescribeSqlLogTasks接口，查询数据库实例DAS企业版的离线任务。

接口说明

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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	数据库实例 ID。	r-bp1nti25tc7bq5****
NodeId	string	否	节点 ID。说明该参数仅适用于集群版实例，可以选择查询指定节点离线任务。若不传该参数，默认返回主节点离线任务。	pi-bp1o58x3ib7e6****
Filters	object []	否	查询筛选条件列表。
Key	string	否	过滤参数。说明支持的过滤参数及其取值请参考请求参数补充说明。	keyWords
Value	string	否	过滤参数的值。	select
StartTime	long	否	查询开始时间，格式为 unix 时间戳，单位为毫秒。	1596177993000
EndTime	long	否	查询结束时间，格式为 unix 时间戳，单位为毫秒。	1608888296000
PageNo	integer	否	分页查询的页码，从 1 开始，默认为 1。	1
PageSize	integer	否	每页最大记录数，默认值为 10。	10

Key 支持的参数和取值：

KeyWords：关键字，多个关键字间使用空格隔开。
LogicalOperator：关键字间的逻辑操作，取值为 and 或 or。
AccountName：用户名。
dbName：数据库名称。
HostAddress：客户端 IP 地址。
MaxConsume：最大耗时，单位毫秒。
MinConsume：最小耗时，单位毫秒。
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。
JobId：对于开通企业版 V0 和 V1 的数据库实例，需要通过异步任务 ID 进一步查询返回结果。

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true
Data	object	返回数据。
List	object []	返回信息列表。
TaskId	string	任务 ID。	9a4f5c4494dbd6713185d87a97aa53e8
InstanceId	string	数据库实例 ID。	r-bp1nti25tc7bq5****
Name	string	任务名称。	SQL审计导出1
Start	long	任务开始时间，格式为 unix 时间戳，单位为毫秒。	1683859555482
End	long	任务结束时间，格式为 unix 时间戳，单位为毫秒。	1705975320000
Status	string	任务状态。 INIT：待调度。 RUNNING：运行中。 FAILED：失败。 CANCELED：已取消。 COMPLETED：完成。说明当任务处于 COMPLETED 时，可以查看离线任务的结果。	RUNNING
LogCount	long	日志总数。	99999
Progress	integer	任务进度。	100
ScanFileSize	long	扫描的文件数量。	3000
Expire	boolean	任务是否过期。 true：是。 false：否。	false
CreateTime	long	任务创建时间，格式为 unix 时间戳，单位为毫秒。	1681363254423
AnalysisTaskFinishTime	long	分析任务完成时间，格式为 unix 时间戳，单位为毫秒。	1712751923000
AnalysisTaskStatus	string	分析任务状态。说明系统内部参数，用户无需关注。	SCAN_ANALYZE_COMPLETED
Result	string	任务类型为 Export 时的链接地址。	https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
TaskType	string	任务类型。 Export：导出任务。 Query：查询任务。	Export
Filters	object []	查询筛选条件列表。
Key	string	过滤参数。说明支持的过滤参数及其取值请参考请求参数补充说明。	keyWords
Value	string	过滤参数的值。	select
Total	long	任务数量。	40
PageNo	long	页码。	1
PageSize	long	每页数量。	10

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8",
        "InstanceId": "r-bp1nti25tc7bq5****\n",
        "Name": "SQL审计导出1",
        "Start": 1683859555482,
        "End": 1705975320000,
        "Status": "RUNNING",
        "LogCount": 99999,
        "Progress": 100,
        "ScanFileSize": 3000,
        "Expire": false,
        "CreateTime": 1681363254423,
        "AnalysisTaskFinishTime": 1712751923000,
        "AnalysisTaskStatus": "SCAN_ANALYZE_COMPLETED",
        "Result": "https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la",
        "TaskType": "Export",
        "Filters": [
          {
            "Key": "keyWords\n",
            "Value": "select\n"
          }
        ]
      }
    ],
    "Total": 40,
    "PageNo": 1,
    "PageSize": 10
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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