查询聚类分析作业详情 - ShowClusteringJob
功能介绍
查询聚类分析作业详情。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/clustering/{job_id}
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
basic_info | DrugJobDto object | 参数解释: 作业基本信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
file | DrugFile object | 参数解释: 分子文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
failed_reasons | Array of FailedReasonRecord objects | 参数解释: 部分失败原因和数量。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
job_result | JobResult object | 参数解释: 作业结果信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 作业ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name | String | 参数解释: 作业的名称。 约束限制: 长度为[1-63]个字符,允许大小写字母、数字、以及特殊字符中划线(-)。 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_id | String | 参数解释: 作业所属空间ID,您可以从获取空间ID中获取。 约束限制: 不涉及 取值范围: 长度为[1-63]个字符,允许大小写字母、数字、以及特殊字符中划线(-)。 默认取值: 不涉及 |
eihealth_project_name | String | 参数解释: 作业所属空间名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels | Array of strings | 参数解释: 作业标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status | String | 参数解释: 作业状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
type | String | 参数解释: 作业类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
create_time | String | 参数解释: 作业创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
finish_time | String | 参数解释: 作业结束时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
start_time | String | 参数解释: 作业开始时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
failed_message | String | 参数解释: 失败提示,当作业执行失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_name | String | 参数解释: 创建任务的用户名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
output_dir | String | 参数解释: 作业结果输出目录。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
expect_charge_num | Double | 参数解释: 预估功能调用消耗次数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
real_charge_num | Double | 参数解释: 实际功能调用消耗次数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
progress | Progress object | 参数解释: 作业进度信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
upstream_job_info | String | 参数解释: 上游作业信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
overall | Float | 参数解释: 整体进度。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
estimated_finish_time | Long | 参数解释: 预计结束时间,毫秒。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
source | String | 参数解释: 受体的数据源。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url | String | 参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.pdb、.mol2、.sdf、.smi为结尾,长度为[1-2000]个字符。 默认取值: 不涉及 |
format | String | 参数解释: 文件格式。 约束限制: 仅数据源source为 RAW 时提供。 取值范围:
默认取值: 不涉及 |
data | String | 参数解释: 文件原始数据。 约束限制: 仅数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符。 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
reason | String | 参数解释: 失败原因。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
count | Integer | 参数解释: 失败数量。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
total_count | Integer | 参数解释: 输入总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
failed_count | Integer | 参数解释: 失败个数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sub_tasks_duration | Array of floats | 参数解释: 子任务运行时长(秒)。 约束限制: 子任务数量范围为[1-30]。 取值范围: 不涉及 默认取值: 不涉及 |
num_molecules | Integer | 参数解释: 分子聚类任务中的分子总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
success_count | Integer | 参数解释: 聚类成功的分子数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询聚类分析作业详情。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/clustering/{job_id} 响应示例
状态码:200
OK
{
"basic_info" : {
"id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"name" : "demo-job",
"labels" : [ "labelA", "labelB" ],
"status" : "FINISHED",
"type" : "CLUSTERING",
"create_time" : "2021-01-30T02:34:36Z",
"start_time" : "2021-01-30T02:34:37Z",
"finish_time" : "2021-01-30T02:53:26Z",
"failed_message" : "null",
"user_name" : "demo-user-name",
"output_dir" : "job-clustering/job-name",
"expect_charge_num" : 0,
"real_charge_num" : 0
},
"file" : {
"source" : "PRIVATE",
"url" : "project:/dir/file"
},
"failed_reasons" : [ {
"reason" : "upstream task failed",
"count" : 1
} ],
"job_result" : {
"num_molecules" : 10000,
"success_count" : 9999
}
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
错误码
请参见错误码。

