- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
DescribeRunGroups
Last updated: 2024-07-26 15:26:15
1. API Description
Domain name for API request: omics.tencentcloudapi.com.
This API is used to query the run group list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeRunGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| ProjectId | No | String | Project ID (If you leave it blank, the default item in the specified region will be used.) |
| Limit | No | Integer | Quantity of returns. It is 10 by default, and the maximum value is 100. |
| Offset | No | Integer | Offset, which defaults to 0. |
| Filters.N | No | Array of Filter | Filter, which supports filtering fields: - Name: Run group name - RunGroupId: Run group ID - Status: Run group status |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of qualified items |
| RunGroups | Array of RunGroup | Run group list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the Run Group List
This example shows you how to query the run group list.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRunGroups
<Common request parameters>
{
"ProjectId": "prj-peaceful-pink-bird-631828",
"Limit": 2,
"Offset": 0
}
Output Example
{
"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": "Submit run environment",
"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": "Test description",
"EnvironmentId": "env-05d0g0w2",
"EnvironmentName": "Submit run environment",
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| OperationDenied | Operation rejected. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.ProjectNotExist | The project does not exist. |
Yes
No
Was this page helpful?