AI 助理
备案控制台
文档
输入文档关键字查找
首页 数据库自治服务 开发参考 API参考 API目录 企业版管理 DescribeSqlLogTask - 查询DAS企业版离线任务详情

DescribeSqlLogTask - 查询DAS企业版离线任务详情

更新时间：
产品详情
相关技术圈
我的收藏

调用DescribeSqlLogTask接口，查询DAS企业版离线任务详情。

接口说明

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

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

调试

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

授权信息

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

请求参数

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

数据库实例 ID。

r-bp1nti25tc7bq5****
TaskIdstring否

任务 ID。

a4f5c4494dbd6713185d87a97aa53e8
PageNointeger否

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

1
PageSizeinteger否

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

10

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Dataobject

返回数据。

CreateTimelong

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

1681363254423
Endlong

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

1608888296000
Expireboolean

任务是否过期。

  • true：是。
  • false：否。
false
Exportstring

导出任务的下载地址。当 TaskType == Export 时才会返回该值。

"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"
Filtersarray<object>

过滤条件。

Filterobject

查询筛选条件。

Keystring

过滤参数的名称。

说明 支持的过滤参数及其取值请参考返回参数补充说明。
keyWords
Valueany

过滤参数的值。

select
Namestring

任务名称。

SQL审计导出1
Queriesarray<object>

离线查询任务结果。 当 TaskType == Query 时才会返回该值。

Querieobject

离线查询任务结果。

AccountNamestring

数据库账号。

testname
Collectionstring

预留参数

None
Consumelong

执行耗时，单位毫秒。

58
CpuTimelong

CPU 执行时间，单位为微秒。

100
DBNamestring

数据库名称。

testdb01
ExecuteTimestring

执行时间，格式为 UTC 时间：yyyy-MM-ddTHH:mm:ssZ。

2023-12-07T02:15:32Z
Extstring

扩展信息字段，备用参数。

None
Frowslong

PolarDB-X 2.0 计算节点（CN）的拉取行数。

10
HostAddressstring

客户端 IP 地址。

11.197.XX.XX
LockTimelong

锁等待时间，单位毫秒。

0
LogicReadlong

逻辑读。

0
NodeIdstring

子节点 ID。

pi-bp1o58x3ib7e6****
OriginTimelong

执行时间戳，格式为 Unix 时间，单位为毫秒。

1701886532000
ParallelDegreestring

PolarDB MySQL 版实例的并行排队时间，单位为毫秒。

10
ParallelQueueTimestring

PolarDB MySQL 版实例的并行度。

2
PhysicAsyncReadlong

物理异步读。

0
PhysicReadlong

物理读。

0
PhysicSyncReadlong

物理同步读。

0
ReturnRowslong

返回行数。

0
Rowslong

PolarDB-X 2.0 数据库实例计算节点总更新或返回的行数。

10
ScanRowslong

扫描行数。

0
Scntlong

PolarDB-X 2.0 计算节点（CN）的 DN 请求数。

10
SqlIdstring

SQL ID。

a4111670e80596c5bf42cf5154438a91
SqlTextstring

SQL 语句详情。

SELECT @@session.transaction_read_only
SqlTypestring

选择 SQL 的类型。取值：

  • SELECT
  • UPDATE
  • DELETE
SELECT
Statestring

执行结果。

  • 0：执行成功。
  • 1：执行失败。
0
ThreadIdlong

线程 ID。

None
TraceIdstring

PolarDB-X 2.0 的跟踪 ID，即 SQL 在数据节点的执行 ID。

14c93b7c7bf00000
TrxIdstring

事务 ID。

200000
UpdateRowslong

更新行数。

0
UseImciEnginestring

PolarDB MySQL 版实例是否使用列存索引。

  • true：是。
  • false：否。
true
Vipstring

查询链接的 endpoint 解析地址。

10.146.XX.XX
Writeslong

RDS SQL Server 引擎的写入数。

10
Startlong

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

1596177993000
Statusstring

任务状态。

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

任务 ID。

9a4f5c4494dbd6713185d87a97aa53e8
TaskTypestring

任务类型。

  • Export：导出任务。
  • Query：查询任务。
Query
Totallong

任务总数。

1
Messagestring

请求返回消息。

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

请求 ID。

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

请求是否执行成功：

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

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。

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "CreateTime": 1681363254423,
    "End": 1608888296000,
    "Expire": true,
    "Export": "\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\"",
    "Filters": [
      {
        "Key": "keyWords\n",
        "Value": "select"
      }
    ],
    "Name": "SQL审计导出1\n",
    "Queries": [
      {
        "AccountName": "testname\n",
        "Collection": "None",
        "Consume": 58,
        "CpuTime": 100,
        "DBName": "testdb01",
        "ExecuteTime": "2023-12-07T02:15:32Z",
        "Ext": "None",
        "Frows": 10,
        "HostAddress": "11.197.XX.XX\n",
        "LockTime": 0,
        "LogicRead": 0,
        "NodeId": "pi-bp1o58x3ib7e6****\n",
        "OriginTime": 1701886532000,
        "ParallelDegree": "10\n",
        "ParallelQueueTime": "2",
        "PhysicAsyncRead": 0,
        "PhysicRead": 0,
        "PhysicSyncRead": 0,
        "ReturnRows": 0,
        "Rows": 10,
        "ScanRows": 0,
        "Scnt": 10,
        "SqlId": "a4111670e80596c5bf42cf5154438a91",
        "SqlText": "SELECT @@session.transaction_read_only",
        "SqlType": "SELECT",
        "State": "0",
        "ThreadId": 0,
        "TraceId": "14c93b7c7bf00000 ",
        "TrxId": "200000\n",
        "UpdateRows": 0,
        "UseImciEngine": "true\n",
        "Vip": "10.146.XX.XX",
        "Writes": 10
      }
    ],
    "Start": 1596177993000,
    "Status": "COMPLETED",
    "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8\n",
    "TaskType": "Query",
    "Total": 1
  },
  "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.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
2024-07-03OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：CreateSqlLogTask - 创建DAS企业版离线任务下一篇：DescribeSqlLogTasks - 查询DAS企业版离线任务列表
文档推荐