获取数据集版本导出详情

更新时间：2025-01-17

功能介绍

本接口用于获取数据集版本的导出任务详情。

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

SDK调用

调用示例

import os
from qianfan  import resources

# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"



resp = resources.console.utils.call_action(
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/dataset", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeExportTask", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "taskId": "task-xxx"
    }
)

print(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(),
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/dataset",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeExportTask",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/dataset")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeExportTask")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-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() {
  //base_api_route:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
  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%",
        "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"
    }
}

{
    "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"
    }
}

{
    "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"
    }
}

{
    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'
    }
}

请求参数

名称	类型	必填	描述
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`

发起数据集版本导出任务

数据清洗V1