1. 接口描述
接口请求域名: batch.tencentcloudapi.com 。
用于获取任务多个实例标准输出和标准错误日志。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTaskLogs。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 作业ID 示例值:job-mawzp3ja |
TaskName | 是 | String | 任务名称 示例值:task |
TaskInstanceIndexes.N | 否 | Array of Integer | 任务实例集合 示例值:["0\r\n","1\r\n"] |
Offset | 否 | Integer | 起始任务实例 示例值:0 |
Limit | 否 | Integer | 最大任务实例数 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 任务实例总数 示例值:1 |
TaskInstanceLogSet | Array of TaskInstanceLog | 任务实例日志详情集合 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务日志详情
输入示例
https://batch.tencentcloudapi.com/?Action=DescribeTaskLogs
&JobId=job-mawzp3ja
&TaskName=task
&TaskInstanceIndexes.0=0
&TaskInstanceIndexes.1=1
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"TaskInstanceLogSet": [
{
"StdoutLog": "data:text/plain;charset=utf-8;base64,bWFpbgpbJ2RlbW8ucHknLCAnMycsICcvbW50L2lucHV0JywgJy9tbnQvb3V0cHV0JywgJzEnXWZsdXNoIHRvIC9tbnQvb3V0cHV0LzE1MzU3MjYwMDQuOTEKZmx1c2ggdG8gL21udC9vdXRwdXQvMTUzNTcyNjAwNi4zOQpmbHVzaCB0byAvbW50L291dHB1dC8xNTM1NzI2MDA3LjcK",
"TaskInstanceIndex": 0,
"StderrLog": "data:text/plain;charset=utf-8;base64,Zmx1c2ggdG8gL21udC9vdXRwdXQvMTUzNTcyNjAwNC45MQpmbHVzaCB0byAvbW50L291dHB1dC8xNTM1NzI2MDA2LjM5CmZsdXNoIHRvIC9tbnQvb3V0cHV0LzE1MzU3MjYwMDcuNwo=",
"StdoutRedirectPath": "",
"StderrRedirectPath": "",
"StdoutRedirectFileName": "",
"StderrRedirectFileName": ""
}
],
"RequestId": "3b1ba3bf-a315-42ec-9e8e-af8def768f8a"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter.JobIdMalformed | 非法的作业ID格式。 |
InvalidParameter.TaskName | 非法的任务名称。 |
InvalidParameter.TaskNameTooLong | 任务名称过长。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Negative | 非法的负值参数。 |
ResourceNotFound.Job | 指定作业不存在。 |
ResourceNotFound.Task | 指定作业任务不存在。 |
ResourceNotFound.TaskInstance | 指定任务实例不存在。 |
UnknownParameter | 未知参数错误。 |