获取任务日志详情

最近更新时间:2018-11-08 20:28:46

1. 接口描述

接口请求域名: batch.tencentcloudapi.com 。

用于获取任务多个实例标准输出和标准错误日志。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskLogs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
JobId String 作业ID
TaskName String 任务名称
TaskInstanceIndexes.N Array of Integer 任务实例集合
Offset Integer 起始任务实例
Limit Integer 最大任务实例数

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务实例总数
TaskInstanceLogSet Array of TaskInstanceLog 任务实例日志详情集合
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务日志详情

输入示例

https://batch.tencentcloudapi.com/?Action=DescribeTaskLogs
&JobId=job-mawzp3ja
&TaskName=task
&TaskInstanceIndexes.0=0
&TaskInstanceIndexes.1=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "3b1ba3bf-a315-42ec-9e8e-af8def768f8a",
    "TaskInstanceLogSet": [
      {
        "StderrLog": "data:text/plain;charset=utf-8;base64,Zmx1c2ggdG8gL21udC9vdXRwdXQvMTUzNTcyNjAwNC45MQpmbHVzaCB0byAvbW50L291dHB1dC8xNTM1NzI2MDA2LjM5CmZsdXNoIHRvIC9tbnQvb3V0cHV0LzE1MzU3MjYwMDcuNwo=",
        "StderrRedirectFileName": "",
        "StderrRedirectPath": "",
        "StdoutLog": "data:text/plain;charset=utf-8;base64,bWFpbgpbJ2RlbW8ucHknLCAnMycsICcvbW50L2lucHV0JywgJy9tbnQvb3V0cHV0JywgJzEnXWZsdXNoIHRvIC9tbnQvb3V0cHV0LzE1MzU3MjYwMDQuOTEKZmx1c2ggdG8gL21udC9vdXRwdXQvMTUzNTcyNjAwNi4zOQpmbHVzaCB0byAvbW50L291dHB1dC8xNTM1NzI2MDA3LjcK",
        "StdoutRedirectFileName": "",
        "StdoutRedirectPath": "",
        "TaskInstanceIndex": 0
      }
    ],
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter.JobIdMalformed 非法的作业ID格式。
InvalidParameter.TaskName 非法的任务名称。
InvalidParameter.TaskNameTooLong 任务名称过长。
InvalidParameterValue 非法的参数值。
InvalidParameterValue.Negative 非法的负值参数。
ResourceNotFound.Job 指定作业不存在。
ResourceNotFound.Task 指定作业任务不存在。
ResourceNotFound.TaskInstance 指定任务实例不存在。
UnknownParameter 未知参数错误