腾讯健康组学平台查询任务批次列表-组学平台相关接口-API 中心-腾讯云

1. 接口描述

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

查询任务批次列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRunGroups。
Version	是	String	公共参数，本接口取值：2022-11-28。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	否	String	项目ID。（不填使用指定地域下的默认项目）示例值：prj-obese-turquoise-skunk-263510
Limit	否	Integer	返回数量，默认为10，最大值为100。示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of Filter	过滤器，支持过滤字段： - Name：任务批次名称 - RunGroupId：任务批次ID - Status：任务批次状态 - ApplicationId：应用ID - Type：类型（支持WDL，NEXTFLOW）示例值：{"Name":["SOAPnuke-20241106163805-0"]}

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的数量。示例值：1
RunGroups	Array of RunGroup	任务批次列表。示例值： [{"ApplicationId": "app-sweet-cerulean-frog-569111","ApplicationName": "base64","ApplicationType": "WDL","CreateTime": "2023-03-15T20:21:34+08:00","Description": "测试描述","EnvironmentId": "env-05d0g0w2","EnvironmentName": "提交任务环境","ErrorMessage": "","ExecutionTime": {"EndTime": "2023-03-15T20:22:01+08:00","StartTime": "2023-03-15T20:21:48+08:00","SubmitTime": "2023-03-15T20:21:34+08:00"},"Input": "omics/100000/project/prj-obese-turquoise-skunk-263510/run-hilarious-aqua-herring-857343/inputs.json","Name": "SOAPnuke-20241106163805-0","Option": {"FailureMode": "","UseCallCache": false,"UseErrorOnHold": false,"UseRelativeOutputPaths": true,"FinalWorkflowOutputsDir": "cos://bucket-10000/output"},"ProjectId": "prj-obese-turquoise-skunk-263510","ProjectName": "run test","RunGroupId": "run-hilarious-aqua-herring-857343","RunStatusCounts": [{"Count": 1,"Status": "SUCCESS"}],"Status": "COMPLETE","TableId": "","TotalRun": 1,"UpdateTime": "2023-03-15T20:22:28+08:00"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务批次列表

查询任务批次列表。

输入示例

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

{
    "ProjectId": "prj-peaceful-pink-bird-631828",
    "Limit": 2,
    "Offset": 0
}

输出示例

{
    "Response": {
        "RequestId": "dfc17a50-4ff2-45b8-959d-86ab346b3d8c",
        "RunGroups": [
            {
                "ApplicationId": "app-sweet-cerulean-frog-569111",
                "ApplicationName": "base64",
                "ApplicationType": "WDL",
                "CreateTime": "2023-03-15T20:52:56+08:00",
                "Description": "",
                "EnvironmentId": "env-05d0g0w2",
                "EnvironmentName": "提交任务环境",
                "ErrorMessage": "",
                "ExecutionTime": {
                    "EndTime": "2023-03-15T20:53:23+08:00",
                    "StartTime": "2023-03-15T20:53:13+08:00",
                    "SubmitTime": "2023-03-15T20:52:56+08:00"
                },
                "Input": "omics/100000/project/prj-peaceful-pink-bird-631828/run-group/run-ashamed-turquoise-rooster-131773/inputs.json",
                "Name": "cloudapi-test",
                "Option": {
                    "FailureMode": "",
                    "UseCallCache": false,
                    "UseErrorOnHold": false,
                    "UseRelativeOutputPaths": true,
                    "FinalWorkflowOutputsDir": "cos://bucket-10000/output"
                },
                "ProjectId": "prj-peaceful-pink-bird-631828",
                "ProjectName": "run test",
                "RunGroupId": "run-ashamed-turquoise-rooster-131773",
                "RunStatusCounts": [
                    {
                        "Count": 1,
                        "Status": "SUCCESS"
                    }
                ],
                "Status": "COMPLETE",
                "TableId": "",
                "TotalRun": 1,
                "UpdateTime": "2023-03-15T20:53:51+08:00"
            },
            {
                "ApplicationId": "app-sweet-cerulean-frog-569111",
                "ApplicationName": "base64",
                "ApplicationType": "WDL",
                "CreateTime": "2023-03-15T20:21:34+08:00",
                "Description": "测试描述",
                "EnvironmentId": "env-05d0g0w2",
                "EnvironmentName": "提交任务环境",
                "ErrorMessage": "",
                "ExecutionTime": {
                    "EndTime": "2023-03-15T20:22:01+08:00",
                    "StartTime": "2023-03-15T20:21:48+08:00",
                    "SubmitTime": "2023-03-15T20:21:34+08:00"
                },
                "Input": "omics/100000/project/prj-peaceful-pink-bird-631828/run-group/run-hilarious-aqua-herring-857343/inputs.json",
                "Name": "base64-20230315202115-0",
                "Option": {
                    "FailureMode": "",
                    "UseCallCache": false,
                    "UseErrorOnHold": false,
                    "UseRelativeOutputPaths": true,
                    "FinalWorkflowOutputsDir": "cos://bucket-10000/output"
                },
                "ProjectId": "prj-peaceful-pink-bird-631828",
                "ProjectName": "run test",
                "RunGroupId": "run-hilarious-aqua-herring-857343",
                "RunStatusCounts": [
                    {
                        "Count": 1,
                        "Status": "SUCCESS"
                    }
                ],
                "Status": "COMPLETE",
                "TableId": "",
                "TotalRun": 1,
                "UpdateTime": "2023-03-15T20:22:28+08:00"
            }
        ],
        "TotalCount": 108
    }
}

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.ProjectNotExist	项目不存在

查询任务批次列表

本页目录：