获取数据集版本导出详情
更新时间：2024-12-23
接口描述
本接口用于获取数据集版本的导出任务详情。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 完全控制千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataOperateAccessPolicy
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/dataset?Action=DescribeExportTask HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"taskId": "task-xxx"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeExportTask |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| taskId | string | 是 | 导出任务ID，示例："task-xxx"，通过调用发起数据集版本导入任务接口，返回的result字段获取 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 导出记录详情，请求成功时返回 |
| code | string | 错误码，请求失败时返回 |
| message | string | 错误信息，请求失败时返回 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| storageType | string | 导出位置的存储类型，说明： · BOS：表示对象存储BOS · sysStorage：表示平台共享存储 |
| storagePath | string | 对应的导出文件完整路径，示例：bos:/bucketName/some/path/exportFileName.zip |
| sizeMB | float | 数据集大小，单位为MB，例：0.01 |
| sampleCount | int | 样本数 |
| exportStatus | string | 导出状态，状态说明： · Exporting：导出中 · ExportFinished：导出完成 · ExportFailed：导出失败 |
| progress | string | 导出进度，说明： · 导出中：该字段值为导出进度，如XX % · 导出完成：该字段值为100% · 导出失败：该字段值为0 |
| creator | string | 导出任务操作人 |
| startTime | string | 导出开始时间，格式：YYYY-MM-DD hh:mm:ss |
| finishTime | string | 导出完成时间，说明： （1）格式：YYYY-MM-DD hh:mm:ss （2）如果导出未完成，该字段为空 |
| downloadUrl | string | 导出文件下载地址，只在导出成功后为非空，示例：https://bucketName.region.bcebos.com/some/path/exportFileName.zip?query |
请求示例
# 替换下列示例中的Authorization、x-bce-date、serviceId值
curl --location 'https://qianfan.baidubce.com/v2/dataset?Action=DescribeExportTask' \
--header 'Authorization: bce-auth-v1/047ab241bad24166xxxxx/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a21944cc53773f3e7ec4xxxxxxxx' \
--header 'x-bce-date: 2023-10-10T07:48:17Z' \
--header 'Content-Type: application/json' \
--data '{
"taskId": "task-xxx"
}'响应示例
{
"requestId": "bdb7afcc-d9a4-4804-7587-8d9afaa53007",
"result": {
"storageType": "sysStorage",
"storagePath": "bos:/bucketName/some/path/exportFileName.zip",
"sizeMB": 0.05,
"sampleCount": 55,
"exportStatus": "ExportFinished",
"progress": "100%",
"creator":"accountName",
"startTime": "2024-08-01 10:31:48",
"finishTime": "2024-08-01 10:31:58",
"downloadUrl": "https://bucketName.region.bcebos.com/some/path/exportFileName.zip?authorization=bce-auth-v1%2F50c8bb753dcb4e1xxxxxxxab83c671162d2ecb"
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。