资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

发起数据集版本导出任务

接口描述

本接口用于对特定数据集版本发起数据导出任务。

权限说明

调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表账号创建与权限分配。需具有以下任一权限:

  • 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
  • 完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
  • 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy

鉴权说明

调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明

请求结构

POST /v2/dataset?Action=CreateExportTask HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "versionId": "ds-xxx",
    "storageType": "sysStorage"
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

  • Query参数
名称 类型 必填 描述
Action string 方法名称,固定值CreateExportTask
  • Body参数
名称 类型 必填 描述
versionId string 数据集版本ID,示例:ds-xxx,可以通过以下任一方式获取该字段值:
· 方式一,通过调用创建数据集接口,返回的versionId字段获取
· 方式二,在控制台-数据集管理列表页面查看,如下图所示:
image.png
storageType string 导出位置的存储类型,可选值如下:
· BOS:表示对象存储BOS
· sysStorage:表示平台共享存储
storagePath string 说明:
(1)存储类型为对象存储BOS时,对应的导出完整路径,示例:bos:/bucketName/some/path/
(2)存储类型为平台共享存储时,不传或者传空字符串

响应头域

除公共头域外,无其它特殊头域。

响应参数

名称 类型 描述
requestId string 请求ID
result string 导出任务ID,请求成功时返回
code string 错误码,请求失败时返回
message string 错误信息,请求失败时返回

请求示例

# 可通过获取导出记录详情接口,获取数据下载链接
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/dataset?Action=CreateExportTask'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5264xxxxxxx374525543'\ 
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\ 
--data '{
    "versionId": "ds-xxx",
    "storageType": "sysStorage"
}'
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/dataset?Action=CreateExportTask'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8fxxxx016e374525543'\ 
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json' \
--data-raw '{
    "versionId": "ds-xxx",
    "storageType": "BOS",
    "storagePath": "bos:/yourBucket/yourDir/"
}'

响应示例

{
	"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
	"result": "task-xxx"
}

错误码

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

名称 描述
requestId 请求ID
code 错误码
message 错误描述信息,帮助理解和解决发生的错误

例如错误返回:

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码,也可以查看错误码说明

上一篇
获取数据集版本导入详情
下一篇
获取数据集版本导出详情