查询数据集导出任务的状态
功能介绍
查询数据集导出任务的状态。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
resource_id |
是 |
String |
资源ID,当前支持传数据集ID。 |
task_id |
是 |
String |
导出任务ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
Long |
任务创建时间。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 |
export_format |
Integer |
导出的目录格式。可选值如下:
|
export_params |
ExportParams object |
导出数据集任务的参数。 |
export_type |
Integer |
导出类型。可选值如下:
|
finished_sample_count |
Integer |
已完成的样本数量。 |
path |
String |
导出的输出路径。 |
progress |
Float |
任务当前进度百分比。 |
status |
String |
任务状态。 |
task_id |
String |
任务ID。 |
total_sample_count |
Integer |
样本总数量。 |
update_time |
Long |
任务更新时间。 |
version_format |
String |
数据集版本格式。可选值如下:
|
version_id |
String |
数据集版本ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
clear_hard_property |
Boolean |
是否清空难例属性。可选值如下:
|
export_dataset_version_format |
String |
导出数据集版本的格式。 |
export_dataset_version_name |
String |
导出数据集版本的名称。 |
export_dest |
String |
数据集导出类型。可选值如下:
|
export_new_dataset_name |
String |
导出新数据集的名称。 |
export_new_dataset_work_path |
String |
导出新数据集的工作目录。 |
ratio_sample_usage |
Boolean |
指定切分比例后,是否按指定比例随机分配训练-验证集。可选值如下:
|
sample_state |
String |
样本状态。可选样本状态如下:
|
samples |
Array of strings |
导出的样本ID列表。 |
search_conditions |
Array of SearchCondition objects |
导出的筛选条件,多个条件之间是或(OR)关系。 |
train_sample_ratio |
String |
指定发布版本时训练集-验证集的切分比例,默认为1.00,即全部分为训练集。 |
参数 |
参数类型 |
描述 |
---|---|---|
coefficient |
String |
根据难度系数筛选。 |
frame_in_video |
Integer |
视频中某帧。 |
hard |
String |
样本级别是否难例。可选值如下:
|
import_origin |
String |
根据数据来源筛选。 |
kvp |
String |
CT剂量,通过剂量来筛选。 |
label_list |
SearchLabels object |
标签搜索条件。 |
labeler |
String |
标注人。 |
metadata |
SearchProp object |
通过样本属性搜索。 |
parent_sample_id |
String |
父样本ID。 |
sample_dir |
String |
根据样本所在目录搜索(目录需要以/结尾),只搜索指定目录下的样本,不支持目录递归搜索。 |
sample_name |
String |
根据样本名称搜索(含后缀名)。 |
sample_time |
String |
样本加入到数据集时,会根据样本在OBS上的最后修改时间(精确到天)建立索引,此处可以根据此时间进行搜索。可选值如下:
|
score |
String |
根据置信度筛选。 |
slice_thickness |
String |
DICOM层厚,通过层厚筛选样本。 |
study_date |
String |
DICOM扫描时间。 |
time_in_video |
String |
视频中某个时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
labels |
Array of SearchLabel objects |
标签搜索条件列表。 |
op |
String |
如要搜索多个标签,则op需要有值;如果只搜索一个标签,则无需指定op的值。可选值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
标签名。 |
op |
String |
多个属性之间的操作类型。可选值如下:
|
property |
Map<String,Array<String>> |
标签属性,是Object格式,存放任意的键值对;key是属性名称,value是取值列表,如value为null表示不根据值搜索,否则搜索的值满足列表中任意一个即可。 |
type |
Integer |
标签类型。可选值如下:
|
请求示例
查询导出任务(导出到OBS)的状态
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks/{task_id}
响应示例
状态码: 200
OK
{ "task_id" : "TZMuy7OKbClkGCAc3gb", "path" : "/test-obs/daoChu/", "export_type" : 3, "version_format" : "Default", "export_format" : 2, "export_params" : { "sample_state" : "", "export_dest" : "DIR", "clear_hard_property" : true, "train_sample_ratio" : 1.0, "ratio_sample_usage" : false }, "status" : "RUNNING", "progress" : 0.0, "create_time" : 1606103424662, "update_time" : 1606103494124 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。