1. 接口描述
接口请求域名: omics.tencentcloudapi.com 。
获取任务详情文件。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetRunJobLog。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-28。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
| RunUuid | 是 | String | 任务Uuid。 示例值:f9dfef5d-b5a2-4668-bf76-239a022e485d |
| JobId | 是 | String | 子任务id 示例值:plan-prophetic-reed-camel-685183 |
| LogType | 是 | String | 日志类型 枚举值:
示例值:stderr |
| ProjectId | 否 | String | 项目ID。 示例值:prj-legal-cyan-goat-888314 |
| Path | 否 | String | 子任务路径,无子任务可填空 示例值:/ |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 日志内容 示例值:Read1 before filtering:total reads: 10000total ..... |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求子任务错误日志
输入示例
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRunJobLog
<公共请求参数>
{
"RunUuid": "f9dfef5d-b5a2-4668-bf76-239a022e485d",
"JobId": "plan-prophetic-reed-camel-685183",
"LogType": "stderr",
"ProjectId": "prj-legal-cyan-goat-888314"
}
输出示例
{
"Response": {
"Content": "Read1 before filtering:\ntotal reads: 10000\ntotal bases: 2500000\nQ20 bases: 2317180(92.6872%)\nQ30 bases: 2133255(85.3302%)\n\nRead2 before filtering:\ntotal reads: 10000\ntotal bases: 2500000\nQ20 bases: 1562112(62.4845%)\nQ30 bases: 1313508(52.5403%)\n\nRead1 after filtering:\ntotal reads: 7245\ntotal bases: 1756762\nQ20 bases: 1712864(97.5012%)\nQ30 bases: 1611609(91.7375%)\n\nRead2 after filtering:\ntotal reads: 7245\ntotal bases: 1756762\nQ20 bases: 1319667(75.1193%)\nQ30 bases: 1131274(64.3954%)\n\nFiltering result:\nreads passed filter: 14490\nreads failed due to low quality: 5506\nreads failed due to too many N: 4\nreads failed due to too short: 0\nreads with adapter trimmed: 1632\nbases trimmed due to adapters: 112016\n\nDuplication rate: 0%\n\nInsert size peak (evaluated by paired-end reads): 204\n\nJSON report: fastp.json\nHTML report: fastp.html\n\nfastp --in1 /vol-8ntc8hn8/env/menv-u0sc501i/execution/FastpDemo/f9dfef5d-b5a2-4668-bf76-239a022e485d/call-RunFastp/inputs/vol-8ntc8hn8/cache/gatk-testdata-1252949230/wgs_fastq/NA12878_20k/H06HDADXX130110.1.ATCACGAT.20k_reads_1.fastq --in2 /vol-8ntc8hn8/env/menv-u0sc501i/execution/FastpDemo/f9dfef5d-b5a2-4668-bf76-239a022e485d/call-RunFastp/inputs/vol-8ntc8hn8/cache/gatk-testdata-1252949230/wgs_fastq/NA12878_20k/H06HDADXX130110.1.ATCACGAT.20k_reads_2.fastq --out1 clean-H06HDADXX130110.1.ATCACGAT.20k_reads_1.fastq --out2 clean-H06HDADXX130110.1.ATCACGAT.20k_reads_2.fastq --json fastp.json --html fastp.html --report_title fastp report \nfastp v0.23.2, time used: 1 seconds\n",
"RequestId": "62c01f22-039d-4c08-8ef1-2adec191a6a2"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidCosKey | COS路径错误 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.CosObjectNotExist | 存储对象不存在 |
| ResourceNotFound.EnvironmentNotExist | 环境不存在 |
| ResourceNotFound.RunNotExist | 任务不存在 |