文档

CreateSqlLogTask - (废弃)创建DAS企业版离线任务

更新时间:

调用CreateSqlLogTask接口,创建DAS企业版的离线任务。

接口说明

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

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 仅开通了 DAS 企业版 V2 和 V3 的数据库实例支持创建离线任务。DAS 企业版各个版本支持的数据库和地域请参见 DAS 产品系列及支持的功能

调试

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

授权信息

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

请求参数

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

数据库实例 ID。

pc-2ze8g2am97624****
NodeIdstring

节点 ID。

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

任务类型

  • Export:导出任务。
  • Query:查询任务。
  • Insight:分析任务。
Export
Namestring

任务名称。

SQL审计导出1
Filtersobject []

筛选条件列表。

Keystring

过滤参数的名称。

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

过滤参数的数值。

select
StartTimelong

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

1596177993000
EndTimelong

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

1608888296000
Rolestring

PolarDB-X 2.0 数据库实例节点信息。

  • polarx_cn:计算节点。

  • polarx_dn:数据节点。

polarx_cn

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
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

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

请求 ID。

83D9D59B-057A-54A9-BFF9-CF2B42F05645
Successstring

请求是否执行成功:

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

返回数据。

TaskIdstring

任务 ID。

54f8041743ca3a9ac5cb9342d050527c
InstanceIdstring

数据库实例 ID。

pc-2ze8g2am97624****
Namestring

任务名称。

Export_test
Startlong

开始时间,格式为 Unix 时间戳,单位为毫秒。

1596177993000
Endlong

j 结束时间,格式为 Unix 时间戳,单位为毫秒。

1608888296000
Statusstring

任务状态。

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

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

1681363254423

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "83D9D59B-057A-54A9-BFF9-CF2B42F05645",
  "Success": "true",
  "Data": {
    "TaskId": "54f8041743ca3a9ac5cb9342d050527c",
    "InstanceId": "pc-2ze8g2am97624****",
    "Name": "Export_test",
    "Start": 1596177993000,
    "End": 1608888296000,
    "Status": "COMPLETED",
    "CreateTime": 1681363254423
  }
}

错误码

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

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

  • 本页导读
文档反馈