GetRunStatus
最后更新时间：2024-11-26 16:47:32
1. API Description
Domain name for API request: omics.intl.tencentcloudapi.com.
This API is used to query run details.
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: GetRunStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| RunUuid | Yes | String | Run UUID |
| ProjectId | No | String | Project ID (If you leave it blank, the default item in the specified region will be used.) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Metadata | RunMetadata | Job details |
| 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 Run Details
This example shows you how to query run details.
Input Example
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRunStatus
<Common request parameters>
{
"RunUuid": "84232c68-a016-4668-b2e3-168a175d6f29",
"ProjectId": "prj-peaceful-pink-bird-631828"
}
Output Example
{
"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. 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.EnvironmentNotExist | The environment does not exist. |
| ResourceNotFound.RunNotExist | The run does not exist. |
是
否
本页内容是否解决了您的问题？