DescribeSqlLogTasks - 查询DAS企业版离线任务列表

查询实例的审计日志任务列表。

接口说明

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

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

调试

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

授权信息

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

请求参数

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

数据库实例 ID。

r-bp1nti25tc7bq5****
NodeIdstring

节点 ID。

说明 该参数仅适用于集群版实例,可以选择查询指定节点离线任务。若不传该参数,默认返回主节点离线任务。
pi-bp1o58x3ib7e6****
Filtersarray<object>

查询筛选条件列表。

Itemobject

查询筛选条件。

Keystring

过滤参数。

说明 支持的过滤参数及其取值请参考请求参数补充说明
keyWords
Valuestring

过滤参数的值。

select
StartTimelong

查询开始时间,格式为 unix 时间戳,单位为毫秒。

1596177993000
EndTimelong

查询结束时间,格式为 unix 时间戳,单位为毫秒。

1608888296000
PageNointeger

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

1
PageSizeinteger

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

10

Key 支持的参数和取值:

  • taskId:任务 ID。
  • keyWords:任务名。
  • status:状态筛选,取值 INIT(待调度)、RUNNING(运行中)、FAILED(失败)、CANCELED(已取消)、COMPLETED(完成)。

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Dataobject

返回数据。

Listarray<object>

返回信息列表。

Listobject

返回信息列表。

AnalysisTaskFinishTimelong

分析任务完成时间,格式为 unix 时间戳,单位为毫秒。

1712751923000
AnalysisTaskStatusstring

分析任务状态。

说明 系统内部参数,用户无需关注。
SCAN_ANALYZE_COMPLETED
CreateTimelong

任务创建时间,格式为 unix 时间戳,单位为毫秒。

1681363254423
Endlong

任务结束时间,格式为 unix 时间戳,单位为毫秒。

1705975320000
Expireboolean

任务是否过期。

  • true:是。
  • false:否。
false
Filtersarray<object>

查询筛选条件列表。

Filterobject

查询筛选条件。

Keystring

过滤参数。

说明 支持的过滤参数及其取值请参考请求参数补充说明
keyWords
Valuestring

过滤参数的值。

select
InstanceIdstring

数据库实例 ID。

r-bp1nti25tc7bq5****
LogCountlong

日志总数。

99999
Namestring

任务名称。

SQL审计导出1
Progressinteger

任务进度。

100
Resultstring

任务类型为 Export 时的链接地址。

https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
ScanFileSizelong

扫描的文件数量。

3000
Startlong

任务开始时间,格式为 unix 时间戳,单位为毫秒。

1683859555482
Statusstring

任务状态。

  • INIT:待调度 。
  • RUNNING:运行中。
  • FAILED:失败。
  • CANCELED:已取消。
  • COMPLETED:完成。
说明 当任务处于 COMPLETED 时,可以查看离线任务的结果。
RUNNING
TaskIdstring

任务 ID。

9a4f5c4494dbd6713185d87a97aa53e8
TaskTypestring

任务类型。

  • Export:导出任务。
  • Query:查询任务。
Export
PageNolong

页码。

1
PageSizelong

每页数量。

10
Totallong

任务数量。

40
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

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

错误码

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

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