获取数据集版本导出详情
更新时间:2024-09-09
功能介绍
本接口用于获取数据集版本的导出任务详情。
SDK调用
使用说明
本文API支持通过千帆Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
调用示例
import json
import os
from qianfan.resources.console.data import Data
# 使用安全认证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 = Data.V2.get_dataset_version_export_task_info("task-xxx")
print(json.dumps(resp.body))
package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(), "/v2/dataset", "DescribeExportTask", map[string]interface{}{
"taskId": "task-xxx",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/dataset")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeExportTask")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"taskId", "task-xxx"
))
.execute();
System.out.println(Json.serialize(response));
}
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
const res = await consoleAction({base_api_route: 'v2/dataset', action: 'DescribeExportTask', data: {
"taskId": "task-xxx"
}
});
console.log(res);
}
main();
返回示例
{
"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%",
"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"
}
}
{
"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%",
"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"
}
}
{
"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%",
"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"
}
}
{
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%',
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'
}
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
task_id | string | 是 | 导出任务ID,示例:"task-xxx",通过调用发起数据集版本导入任务接口,返回的result字段获取 |
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/dataset
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值application/json |
x-bce-date | string | 是 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息。更多参见鉴权认证,签名工具可参考IAM签名工具 |
- 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 |
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%",
"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."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。