1. 接口描述
接口请求域名： omics.tencentcloudapi.com 。
查询作业详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetRunCalls。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
| RunUuid | 是 | String | 任务Uuid。 示例值：84232c68-a016-4668-b2e3-168a175d6f29 |
| Path | 是 | String | 作业路径 示例值：/ed4199e3-3513-444e-9090-3413fd6d3e44 |
| ProjectId | 否 | String | 项目ID。 （不填使用指定地域下的默认项目） 示例值：prj-peaceful-pink-bird-631828 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Calls | Array of RunMetadata | 作业详情。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询作业详情
查询作业详情。
输入示例
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRunCalls
<公共请求参数>
{
"RunUuid": "84232c68-a016-4668-b2e3-168a175d6f29",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Path": "/"
}输出示例
{
"Response": {
"Calls": [
{
"CallCached": false,
"CallName": "sub_workflow",
"Command": "",
"EndTime": "2022-10-31T14:11:18+08:00",
"ErrorMessage": "{\"key\": \"value\"}",
"Input": "{\"base64_in\": \"/cfs-10-8-16-3/omics/file_cache/gene-1252949230/samples.csv\"}",
"JobId": "",
"Output": "{\"sub_workflow.sub_output\": \"/cfs-10-8-16-3/cluster/omics-a6z22tn9/execution/main_workflow/84232c68-a016-4668-b2e3-168a175d6f29/call-sub_workflow/sub_workflow/ed4199e3-3513-444e-9090-3413fd6d3e44/call-base64/base64/87ab7713-6f0f-4452-8da9-fbaa40f7e567/call-encode_base64/execution/base64/samples.csv.base64\"}",
"ParentId": "84232c68-a016-4668-b2e3-168a175d6f29",
"PostProcess": false,
"Preprocess": true,
"RunId": "ed4199e3-3513-444e-9090-3413fd6d3e44",
"RunType": "Workflow",
"Runtime": "{\"key\": \"value\"}",
"ScatterIndex": "",
"StartTime": "2022-10-31T14:10:15+08:00",
"Status": "COMPLETE",
"Stderr": "",
"Stdout": "",
"SubmitTime": "2020-09-22T00:00:00+00:00",
"Meta": ""
}
],
"RequestId": "e954d872-2955-4592-901e-38cb6678b88c"
}
}示例2 查询子作业详情
查询子作业详情。需要指定Path为上一级GetRunCalls中RunType为Workflow或者Scatter项目的RunId。
输入示例
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRunCalls
<公共请求参数>
{
"RunUuid": "84232c68-a016-4668-b2e3-168a175d6f29",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Path": "/ed4199e3-3513-444e-9090-3413fd6d3e44"
}输出示例
{
"Response": {
"Calls": [
{
"CallCached": false,
"CallName": "base64",
"Command": "",
"EndTime": "2022-10-31T14:11:15+08:00",
"ErrorMessage": "{\"key\": \"value\"}",
"Input": "{\"input_file\": \"/cfs-10-8-16-3/omics/file_cache/gene-1252949230/samples.csv\"}",
"JobId": "",
"Output": "{\"base64.output_file\": \"/cfs-10-8-16-3/cluster/omics-a6z22tn9/execution/main_workflow/84232c68-a016-4668-b2e3-168a175d6f29/call-sub_workflow/sub_workflow/ed4199e3-3513-444e-9090-3413fd6d3e44/call-base64/base64/87ab7713-6f0f-4452-8da9-fbaa40f7e567/call-encode_base64/execution/base64/samples.csv.base64\"}",
"ParentId": "ed4199e3-3513-444e-9090-3413fd6d3e44",
"PostProcess": false,
"Preprocess": true,
"RunId": "87ab7713-6f0f-4452-8da9-fbaa40f7e567",
"RunType": "Workflow",
"Runtime": "{\"key\": \"value\"}",
"ScatterIndex": "",
"StartTime": "2022-10-31T14:10:17+08:00",
"Status": "COMPLETE",
"Stderr": "",
"Stdout": "",
"SubmitTime": "2020-09-22T00:00:00+00:00",
"Meta": ""
}
],
"RequestId": "35431cd8-6913-4c28-808f-290268cb9813"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.EnvironmentNotExist | 环境不存在 |
| ResourceNotFound.RunNotExist | 任务不存在 |
