查询批量下载任务详情
功能介绍
查询批量下载任务详情。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
eihealth_project_id |
是 |
String |
参数解释: 空间ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
task_id |
是 |
String |
参数解释: 下载任务ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 任务状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
filename |
String |
参数解释: 下载文件名。 约束限制: 不涉及 取值范围: 长度为[1-512]个字符。 默认取值: 不涉及 |
out_dir |
String |
参数解释: 下载路径。 约束限制: 不涉及 取值范围: 长度为[1-2000]个字符。 默认取值: 不涉及 |
progress |
TaskProgress object |
参数解释: 任务进度。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询分子或分子复合物批量下载任务详情。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download/{task_id}
响应示例
状态码:200
查询分子或分子复合物批量下载任务详情响应体。
{ "status" : "FINISHED", "out_dir" : "zb_test:/a/b/Docking-202401091947-6sn7_complex_7abc.zip", "filename" : "Docking-202401091947-6sn7_complex_7abc.zip" }
状态码
状态码 |
描述 |
---|---|
200 |
查询分子或分子复合物批量下载任务详情响应体。 |
错误码
请参见错误码。