查询任务日志

最近更新时间:2025-04-25 01:26:38

我的收藏

1. 接口描述

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

本接口(DescribeTaskLog)用于获取spark 作业任务日志详情

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskLog。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 列表返回的Id
示例值:eks-1
StartTime Integer 开始运行时间,unix时间戳(毫秒)
示例值:165234344221
EndTime Integer 结束运行时间,unix时间戳(毫秒)
示例值:165234344221
Limit Integer 分页大小,最大1000,配合Context一起使用
示例值:100
Context String 下一次分页参数,第一次传空。透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。
示例值:下一次分页参数
Asc Boolean 是否升序排列,true:升序排序,false:倒序,默认false,倒序排列
示例值:false
Filters.N Array of Filter 预览日志的通用过滤条件
BatchId String SparkSQL任务唯一ID
示例值:dsaj-dasjw-cxask-dasad

3. 输出参数

参数名称 类型 描述
Context String 下一次分页参数
示例值:Y29udGV4dC0xNjRiYzJlMy02OGM3LTQwNDctOTU1Ni0zYjkwMThkYTY3YWMxNzM4ODAyNzgxNDc4
ListOver Boolean 是否获取完结
示例值:false
Results Array of JobLogResult 日志详情
LogUrl String 日志url
示例值:""(已废弃)
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取spark 作业任务日志详情

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskLog
<公共请求参数>

{
    "TaskId": "84f55bb7-4f9c-4995-90c5-a40fdff9bc62",
    "StartTime": 1736931692631,
    "EndTime": 1737104492631,
    "Limit": 10,
    "Context": ""
}

输出示例

{
    "Response": {
        "Context": "",
        "ListOver": true,
        "LogUrl": "",
        "RequestId": "********-****-****-****-303d24983adb",
        "Results": []
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.BatchSQLFiltersKeyTypeNotMath 指定的交互式SQL任务Filter.Key不匹配,当前仅支持: task-sql-keyword/task-operator/batch-id/session-id/task-state
InvalidParameter.BatchSQLTaskSortByTypeNotMatch 交互式SQL任务指定SortBy类型不匹配,当前仅支持: create-time/resource-usage
InvalidParameter.InvalidFilterLength 过滤条件个数非法,当指定了过滤条件时,过滤条件的个数应该大于等于1个,且小于等于5个
InvalidParameter.InvalidSQL SQL解析失败。
InvalidParameter.InvalidTimeParameter 日期参数异常,如结束时间早于开始时间
InvalidParameter.ParameterNotFoundOrBeNone 找不到参数或参数为空
InvalidParameter.SQLTaskNotFound 指定的SQL任务不存在
InvalidParameter.SparkJobNotFound 指定的Spark任务不存在
InvalidParameter.TaskStateTypeNotMath 指定的任务状态不匹配,当前仅支持: 0:初始化, 1:运行中, 2:成功, 3:数据写入中, 4:排队中, -1:失败, -3:删除
ResourceNotFound.BatchSQLTaskNotFound 指定的交互式SQL任务不存在
ResourceNotFound.BatchSQLTaskNotUnique 指定的交互式SQL任务不唯一