创建异步导出任务

最近更新时间:2025-07-01 16:08:22

我的收藏

功能描述

本 API 接口创建异步检索导出任务,并将检索结果,异步存放到指定的 COS 桶目录下。该接口适用于处理大规模检索请求场景,当检索结果数据庞大、无法同步返回时,用户可先发起请求,随后异步给出检索结果。

授权说明

通过子账号使用时,需要在 授权策略 的 action 中添加 ci:CreateDatasetExport 权限,数据万象支持的所有操作接口请参见 action

使用限制

单账号默认并发数为1,最大排队任务数为100。

服务开通

使用该功能将默认为您开通数据万象,并绑定存储桶,无需角色授权,即可直接使用。

请求

请求示例

POST /datasetquery/export HTTP/1.1
Host: <AppId>.ci.<Region>.myqcloud.com
Authorization: Auth String
Content-Length: xxx
Content-Type: application/json
Accept: application/json
说明:
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

{
"Name": "fortest",
"DatasetName": "test",
"Query": {
"Operation": "and",
"SubQueries": [{
"Field": "ContentType",
"Value": "image/jpeg",
"Operation": "eq"
},
{
"Field": "Size",
"Value": "1000",
"Operation": "gt"
}
]
},
"Output": {
"Bucket": "test-1250000000",
"Object": "prefix001",
"Region": "ap-beijing"
}
}

请求参数

具体参数如下:
参数名称
描述
类型
是否必选
Name
新创建任务的名称,支持中文、英文、数字、—和_,长度限制128字符
String
DatasetName
数据集名称,同一个账户下唯一
String
Query
简单查询参数条件,可自嵌套
Container
Output
任务结果存放位置
Container
Container 类型 Query 的具体数据描述,参见 简单查询 接口中 Query 字段的说明。
Container 类型 Output 的具体数据描述如下:
参数名称
父节点
描述
类型
是否必选
Region
Request.Output
存储结果桶的地域
String
Bucket
Request.Output
存储结果的存储桶
String
Object
Request.Output
输出结果的文件名
String

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

{
"Job": {
"CreateTime": "2025-04-09T19:38:08.454310276+08:00",
"JobId": "xxxxxx",
"Name": "fortest",
"Output": {
"Bucket": "test-1250000000",
"Object": "prefix001",
"Region": "ap-beijing"
},
"Query": {
"Field": "",
"Operation": "and",
"SubQueries": [{
"Field": "ContentType",
"Value": "image/jpeg",
"Operation": "eq"
},
{
"Field": "Size",
"Value": "1000",
"Operation": "gt"
}
],
"Value": ""
},
"StartTime": "1970-01-01T00:00:00+08:00",
"EndTime": "1970-01-01T00:00:00+08:00",
"State": "todo"
},
"RequestId": "NjdmNjVjMjBfNzM0NjZjMT**********"
}
响应包体具体数据内容如下:
参数名称
类型
描述
RequestId
String
请求 ID
Job
Container
创建的任务信息
Job 节点内容:
参数名称
类型
描述
CreateTime
String
任务创建时间
JobId
String
任务 JobId,查询时需要
Name
String
任务名称
Output
Container
任务结果存放位置,和请求时传入值相同
Query
Container
简单查询参数条件,和请求时传入值相同
StartTime
String
任务启动时间
EndTime
String
任务结束时间
State
String
任务状态,包含 todo(待执行) / running(执行中) / failed(执行失败) / done(执行成功)