创建明细数据异步任务。
接口说明
使用该接口需满足以下前提条件：
- 使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
- 在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
- 仅开通了 DAS 企业版的数据库实例支持创建离线任务。DAS 企业版各个版本支持的数据库和地域请参见 DAS 产品系列及支持的功能。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hdm:CreateSqlLogTask | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 否 | 数据库实例 ID。 | pc-2ze8g2am97624**** |
| NodeId | string | 否 | 节点 ID。 说明
该参数仅适用于集群版实例，可以选择查询指定节点离线任务。若不传该参数，默认返回主节点离线任务。
| pi-uf6k5f6g3912i**** |
| Type | string | 否 | 任务类型
说明
Export 支持的过滤参数及其取值请参考请求参数补充说明。
| Export |
| Name | string | 否 | 任务名称。 | SQL审计导出1 |
| Filters | array<object> | 否 | 筛选条件列表。 | |
| Item | object | 否 | 筛选条件。 | |
| Key | string | 否 | 过滤参数的名称。 说明
支持的过滤参数及其取值请参考请求参数补充说明。
| KeyWords |
| Value | string | 否 | 过滤参数的数值。 | select |
| StartTime | long | 否 | 任务的开始时间，格式为 Unix 时间戳，单位为毫秒。 | 1596177993000 |
| EndTime | long | 否 | 任务结束时间，格式为 unix 时间戳，单位为毫秒。 | 1608888296000 |
| Role | string | 否 | PolarDB-X 2.0 数据库实例节点信息。
| polarx_cn |
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。
- JobId：通过异步任务 ID 进一步查询返回结果。
- columns：Type = Export，任务类型为导出任务时，传入选择的导出列，导出列用空格隔开，可选的有
- columnDBName：数据库
- columnThreadId：线程 ID
- columnAccountName：用户
- columnHostAddress：客户端 IP
- columnSqlType：sql 类型
- columnState：状态
- columnConsume：耗时 us
- columnUpdateRows：更新行数
- columnScanRows：扫描行数
- columnReturnRows：返回行数
- columnLockTime：锁等待时间
- columnLogicRead：逻辑读
- columnPhysicSyncRead：物理同步读
- columnPhysicASyncRead：物理异步读
- columnOriginTime：执行时间（us）
- columnExecuteTime：执行时间（类似于 2024-07-30 11:00:00）
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
| 403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。