发起数据集导出任务

开发环境

http://dev-cn.your-api-server.com

POST

https://qianfan.baidubce.com/wenxinworkshop/dataset/export

功能介绍

该接口用于发起数据集导出任务。

接口调用效果，与下图操作实现效果类似，同产品页面操作有区别，具体以接口参数为准。

接口调用成功后，可以在数据集管理页面，查看导出状态；导出完成后，可以获取到下载地址等。

注意事项

鉴权机制，调用本文API，使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等鉴权，无法使用获取Access Token的方式鉴权，具体鉴权认证机制参考“百度云鉴权认证机制”。

示例2:导出全部数据到用户Bos

导出到用户Bos，导出全部数据，包含源文件及已有的标注文件

bash

示例3:导出源文件到平台存储

导出到平台存储，仅导出源文件，通过获取数据集导出记录接口，获取数据下载链接

bash

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

数据管理相关错误码，请查看错误码说明。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qianfan.baidubce.com/wenxinworkshop/dataset/export?access_token	=' \
--header 'Content-Type;' \
--header 'x-bce-date;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "datasetId": 2304,
    "exportTo": 0,
    "exportType": 1,
    "exportFormat": 0
}'

响应示例

{
    "log_id": "string",
    "result": true,
    "status": 0,
    "success": true
}

请求参数

Query 参数

access_token

string

必需

通过API Key和Secret Key获取的access_token，参考Access Token获取

Header 参数

Content-Type

string

必需

HTTP请求内容的类型，固定值：application/json

x-bce-date

string

必需

当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z

Authorization

string

必需

用于验证请求合法性的认证信息。更多参见鉴权认证，签名工具可参考IAM签名工具

Body 参数application/json

datasetId

integer

必需

数据集版本ID，可以通过以下任一方式获取该字段值： · 方式一，通过调用创建数据集接口，返回的id字段获取 · 方式二，在千帆控制台-数据集管理列表页面查看，如下图所示：

exportTo

integer

必需

导出到的存储，可选值如下： · 0：平台存储 · 1：用户Bos

exportType

integer

必需

导出数据类型，可选值如下： · 1：导出全部数据，包含源文件及已有的标注文件 · 2：仅导出源文件

exportFormat

integer

必需

导出格式，固定值为0，表示平台默认格式

示例

返回响应

🟢200成功

application/json

Body

log_id

string

操作记录id

必需

result

boolean

必需

发起数据集导出任务是否成功

status

integer

状态码

必需

success

boolean

是否操作成功

必需

修改于 2023-11-16 08:43:58

获取数据集状态详情

删除数据集

发起数据集导出任务

功能介绍#

注意事项#

示例2:导出全部数据到用户Bos#

示例3:导出源文件到平台存储#

错误码#

请求参数

返回响应

功能介绍

注意事项

示例2:导出全部数据到用户Bos

示例3:导出源文件到平台存储

错误码