发起数据集导出任务
更新时间:2024-11-08
注意:为提升开发者使用体验,平台升级了数据集管理接口。推荐使用数据集管理V2版本接口,功能更全面、且接口更规范,详见数据集管理API列表;本文内容不再更新,由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入V2版本接口。
功能介绍
该接口用于发起数据集导出任务。
接口调用成功后,可以查看导出状态;导出完成后,可以获取到下载地址等。
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
SDK调用
调用示例
import os
from qianfan import resources
from qianfan.resources.console.consts import DataExportDestinationType
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 导出
resp = resources.Data.create_dataset_export_task(
"ds-7pkzh1exthpuy10n",
DataExportDestinationType.PrivateBos,
True,
"bucket_name"
)
返回示例
QfResponse(code = 200, headers = {...
}, body = {
'log_id': 'st07grbf9f9tva',
'result': True,
'status': 200,
'success': True
})
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
dataset_id | string | 是 | 数据集版本ID,说明: (1)可以通过以下任一方式获取该字段值: · 方式一,通过调用创建数据集接口,返回的datasetId字段获取 · 方式二,在控制台-数据集管理列表页面,点击详情,查看版本信息,如下图所示: (2)该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取 |
export_destination_type | DataExportDestinationType | 是 | 导出到的存储,可选值如下: · DataExportDestinationType.PlatformBos:平台存储 · DataExportDestinationType.PrivateBos:对象存储BOS |
is_export_with_annotation | bool | 否 | 导出数据类型,,默认值为 True,可选值如下: · True:导出全部数据,包含源文件及已有的标注文件 · False:仅导出源文件 |
storage_id | string | 否 | 导出到对象存储BOS时需要填写导入到的bucket,示例:yourBucketName |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | bool | 发起数据集导出任务是否成功 |
status | int | 状态码 |
success | bool | 是否操作成功 |