腾讯健康组学平台查询任务详情

1. 接口描述

接口请求域名： omics.tencentcloudapi.com 。

查询任务详情。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetRunStatus。
Version	是	String	公共参数，本接口取值：2022-11-28。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。
RunUuid	是	String	任务Uuid。示例值：84232c68-a016-4668-b2e3-168a175d6f29
ProjectId	否	String	项目ID。（不填使用指定地域下的默认项目）示例值：prj-peaceful-pink-bird-631828

3. 输出参数

参数名称	类型	描述
Metadata	RunMetadata	作业详情。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务详情

查询任务详情。

输入示例

POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRunStatus
<公共请求参数>

{
    "RunUuid": "84232c68-a016-4668-b2e3-168a175d6f29",
    "ProjectId": "prj-peaceful-pink-bird-631828"
}

输出示例

{
    "Response": {
        "Metadata": {
            "CallCached": false,
            "CallName": "main_workflow",
            "Command": "",
            "EndTime": "2022-10-31T14:11:23+08:00",
            "ErrorMessage": "{\"key\": \"value\"}",
            "Input": "{\"main_workflow.base64_in\": \"cos://gene-1252949230/samples.csv\"}",
            "JobId": "",
            "Output": "{\"main_workflow.main_output\": \"cos://gene-1252949230/outputs/import/out/base64/samples.csv.base64\"}",
            "ParentId": "84232c68-a016-4668-b2e3-168a175d6f29",
            "PostProcess": false,
            "Preprocess": true,
            "RunId": "84232c68-a016-4668-b2e3-168a175d6f29",
            "RunType": "Workflow",
            "Runtime": "{\"key\": \"value\"}",
            "ScatterIndex": "",
            "StartTime": "2022-10-31T14:10:13+08:00",
            "Status": "SUCCESS",
            "Stderr": "",
            "Stdout": "",
            "SubmitTime": "2022-10-31T14:10:12+08:00",
            "Meta": ""
        },
        "RequestId": "b970585c-c5bb-48e2-ac90-82c59dcadd48"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。
ResourceNotFound.EnvironmentNotExist	环境不存在
ResourceNotFound.RunNotExist	任务不存在

查询任务详情

本页目录：