数据湖计算 DLC AI DLC 获取作业结果集

1. 接口描述

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

获取 SQL 作业结果集 Action. 仅 MinorType=SPARK_SQL 有效（Batch 固定返回 State=NOT_SUPPORTED）。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJobResult。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
JobId	是	String	作业唯一标识符（ID）。必填。示例值：string
Page	否	Integer	页码，从1开始，默认为1. 示例值：1
PageSize	否	Integer	每页返回数量，默认为10. 示例值：10
StatementIndex	否	Integer	Statement 序号（1-based），多语句作业时指定；缺省为 0，取整作业第一个结果集. 示例值：0

3. 输出参数

参数名称	类型	描述
Total	Integer	总记录数. 示例值：0
JobId	String	作业 ID。示例值：string
State	String	结果状态（对客）：SUCCEEDED（结果集可用，含 0 行——DDL/DML 等无结果集语句亦归入此类，message 说明）/ UNAVAILABLE（终态无结果：statement 已失败或取消）/ ERROR（结果集拉取出错）/ NOT_READY（结果未就绪）/ NOT_SUPPORTED（作业形态不产出结果集）。示例值：SUCCEEDED
Message	String	状态描述（SUCCEEDED 0 行时为无结果集说明；ERROR 为错误信息；UNAVAILABLE 为 statement 失败/取消原因）。示例值：string
Columns	Array of ResultColumn	列定义列表（按结果集列顺序；State=SUCCEEDED 才有）。
TotalRows	Integer	结果集全量行数（未按在线展示上限封顶）。Total 为在线可见行数，二者不等说明仅部分行可内联查看，完整结果通过 Download 获取。示例值：0
Rows	Array of ResultRow	行数据（State=SUCCEEDED 才有），每行为 {"Values": [单元格值...]} 数组。
Truncated	Boolean	本页内容是否因响应大小限制被截断（单元格/行超限，结果集仅 1 行时也可能触发）。行数超过在线展示上限不由本标记表达，以 TotalRows > Total 判断，完整结果通过 Download 获取. 示例值：false
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取作业结果集

输入示例

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

{
    "Page": 1,
    "PageSize": 10,
    "JobId": "job-9f3a2b1c"
}

输出示例

{
    "Response": {
        "Total": 1,
        "JobId": "job-9f3a2b1c",
        "State": "SUCCEEDED",
        "Message": "OK",
        "Columns": [
            {
                "Name": "id",
                "DataType": "BIGINT",
                "Comment": "行号",
                "Nullable": true
            },
            {
                "Name": "job_name",
                "DataType": "STRING",
                "Comment": "作业名",
                "Nullable": true
            },
            {
                "Name": "state",
                "DataType": "STRING",
                "Comment": "作业状态",
                "Nullable": true
            }
        ],
        "TotalRows": 1,
        "Rows": [
            {
                "Values": [
                    "1",
                    "spark-sql-demo",
                    "SUCCEEDED"
                ]
            }
        ],
        "Truncated": false,
        "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	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied.ServiceNotActivated	服务未开通
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。

AI DLC 获取作业结果集

本页目录：