数据湖计算 DLC AI DLC 查询作业日志

1. 接口描述

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

统一作业日志查询 Action。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJobLog。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
JobId	是	String	作业 ID（必填）。示例值：string
LogType	否	String	日志类型（必填）。可选值：SPARK_SQL_OPERATION / SPARK_BATCH_OPERATION / SPARK_LAUNCH / SPARK_DRIVER_STDOUT / SPARK_DRIVER_LOG4J / SPARK_EXECUTOR_STDOUT / SPARK_EXECUTOR_LOG4J。示例值：SPARK_SQL_OPERATION
StatementIndex	否	Integer	Statement 序号（1-based，仅 LogType=SPARK_SQL_OPERATION 时可传），定位多语句作业中的具体语句。示例值：0
Cursor	否	String	分页游标（首页不传，后续页原样透传上一响应的 Cursor；不透明，无需解析）。无法续读时以 HasMore=false 终止分页。示例值：string
Limit	否	Integer	返回上限（行数），范围 [1, 1000]。示例值：0
Keyword	否	String	关键词过滤。示例值：string
PodName	否	String	Pod 名称过滤。示例值：string
LogLevel	否	String	日志级别过滤。取值：ERROR / WARN / INFO / DEBUG / TRACE，非法值拒绝。示例值：string
From	否	Integer	起始时间，Unix 毫秒。示例值：0
To	否	Integer	结束时间，Unix 毫秒。示例值：0

3. 输出参数

参数名称	类型	描述
Lines	Array of String	日志行数据。示例值：["string"]
Cursor	String	下一页游标（不透明令牌，原样透传回请求即可；无更多日志时不返回）。示例值：string
HasMore	Boolean	是否还有更多日志。示例值：false
Results	Array of ClsLogEntry	日志条目列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业日志

输入示例

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

{
    "JobId": "job-9f3a2b1c",
    "LogType": "SPARK_SQL_OPERATION",
    "Limit": 100
}

输出示例

{
    "Response": {
        "Lines": [
            "26/01/01 12:41:16 INFO SparkContext: Running Spark version 3.5.5"
        ],
        "Cursor": "eyJvZmZzZXQiOjEwMH0=",
        "HasMore": true,
        "Results": [
            {
                "Time": 1767256876123,
                "LogJson": "{\"level\":\"INFO\",\"message\":\"SparkContext: Running Spark version 3.5.5\"}"
            }
        ],
        "RequestId": "f4a1c9b2-7d3e-4a58-9c62-1e8b5d7a2f43"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ApiCallFailed	调用下游计费接口失败，资源销毁通知未送达
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.LogType	日志类型参数无效
InvalidParameterValue.StatementIndex	SQL语句Index参数错误
MissingParameter	缺少参数错误。
OperationDenied.ServiceNotActivated	服务未开通
ResourceNotFound	资源不存在。
ResourceNotFound.Job	作业不存在。
ResourceNotFound.Warehouse	计算引擎不存在
UnauthorizedOperation	未授权操作。

AI DLC 查询作业日志

本页目录：