获取数据集导出记录
更新时间:2024-09-23
注意: 为提升开发者使用体验,本文内容已合并至对应API文档,请查看API鉴权及调用-数据管理-获取数据集导出记录;本文档已于2024年6月28日在平台文档中心下线,内容不再更新。
功能介绍
用于获取某个数据集发起的导出记录。
注意事项
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证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 = resources.Data.get_dataset_export_records("ds-7pkzh1exthpuy10n")
print(resp)
返回示例
QfResponse(code = 200, headers = {...
},
body = {
'log_id': 'w5wti9jphq6bdj75',
'result': [{
'id': 9772,
'creatorName': 'username',
'storageId': 'bucketname',
'storagePath': 'bos:/bucketname/xxxx.zip',
'size': 0.05,
'exportFormat': 0,
'exportType': 1,
'status': 2,
'recordNum': 35,
'exportTo': 1,
'downloadUrl': 'https://bj.bcebos.com/xxx/bbbb.zip?authorization=bce-auth-xxxx',
'startTime': '2023-11-08 22:11:26',
'finishTime': '2023-11-08 22:12:05'
}],
'status': 200,
'success': True
}
)
参数说明
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
dataset_id | string | 是 | 查询的数据集版本ID,示例:ds-7pkzh1exthpuy10n,说明: (1)可以通过以下任一方式获取该字段值: · 方式一,通过调用创建数据集接口,返回的datasetId字段获取 · 方式二,在控制台-数据集管理列表页面,点击详情,在版本信息页查看,如下图所示: (2) 该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
status | int | 状态码 |
success | bool | 是否操作成功 |
result | list[dict] | 导出记录列表,可能有多次导出 |
result说明
名称 | 类型 | 描述 |
---|---|---|
creatorName | string | 执行本次导出的用户的名称 |
dataType | int | 数据类型 |
storageId | string | 导出到的存储卷 |
storagePath | string | 导出到的路径 |
size | int | 数据集大小,单位为MB |
exportFormat | int | 导出格式,说明: · 0:平台默认格式 |
exportType | int | 导出类型,说明: · 1:导出全部数据,包含源文件及已有的标注文件 · 2:仅导出源文件 |
status | int | 导出状态,说明: · -1:未发起过导出 · 0:导出初始化 · 1:导出进行中 · 2:导出完成 · 3:导出失败 |
recordNum | int | 数据集中的数据量 |
exportTo | int | 导出到的存储,说明: · 0:导出到本地 · 1:导出到BOS |
downloadUrl | string | 下载地址 |
startTime | string | 导出开始时间 |
finishTime | string | 导出终止时间 |