帮你快速理解、总结文档立即下载
文档中心>数据湖计算 DLC>API 文档>AI DLC 作业管理相关接口>AI DLC 查询作业定义列表

AI DLC 查询作业定义列表

最近更新时间：2026-09-25 02:00:47
我的收藏

本页目录：

1. 接口描述

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

查询作业定义列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeJobDefinitions。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
Page 否 Integer

页码，从1开始，默认为1.


示例值：1
PageSize 否 Integer

每页返回数量，默认为10.


示例值：10
Filters.N 否 Array of Filter

高级过滤条件列表，元素 Name 为过滤字段名（PascalCase，可用字段与操作符约束见各接口 Filters 说明），Values 为过滤值列表；未列入白名单或非 PascalCase 的 Name 报 InvalidParameter。
SortFields.N 否 Array of SortField

排序字段列表，元素 Field 为排序字段名（PascalCase，与响应字段命名对齐，可用字段见各接口 SortFields 说明），Order 为排序方向（ASC/DESC，不传默认 DESC）；未列入白名单或非 PascalCase 的 Field 报 InvalidParameter。
CreateTimeStart 否 Integer

创建时间下限（Unix 毫秒时间戳）。


示例值：0
CreateTimeEnd 否 Integer

创建时间上限（Unix 毫秒时间戳）。


示例值：0
InstanceTimeRange 否 Integer

作业实例计数时间窗口（毫秒时长）。不传时默认 7 天。


示例值：0

3. 输出参数

参数名称 类型 描述
Total Integer

总记录数.


示例值：0
Items Array of JobDefinitionItemInfo

作业定义列表项。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业定义列表

输入示例

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

{
    "Page": 1,
    "PageSize": 10,
    "Filters": [
        {
            "Name": "MinorType",
            "Operator": "EQ",
            "Values": [
                "SPARK_SQL"
            ]
        }
    ],
    "SortFields": [
        {
            "Field": "UpdateTime",
            "Order": "DESC"
        }
    ]
}

输出示例

{
    "Response": {
        "Total": 1,
        "Items": [
            {
                "JobDefinitionId": "jd-4b7e15",
                "Name": "spark-demo",
                "Description": "演示用途的配置",
                "MajorType": "SPARK",
                "MinorType": "SPARK_SQL",
                "CheckpointLocation": "cosn://demo-bucket/checkpoints/demo_stream",
                "CreatorSubUin": "700281534962",
                "CreateTime": 1767256876123,
                "UpdateTime": 1767256876123,
                "PartitionCode": "dlc-p-nwruuglc",
                "PartitionName": "spark-demo-partition",
                "QueueName": "root.default",
                "RunMode": "WAREHOUSE",
                "WarehouseId": "wh-8f21c3",
                "InstanceCount": 1,
                "RuntimeCode": "spark-3.5.5",
                "RuntimeName": "Spark 3.5.5",
                "WarehouseName": "spark-warehouse"
            }
        ],
        "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ApiCallFailed 调用下游计费接口失败，资源销毁通知未送达
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied.ServiceNotActivated 服务未开通
UnauthorizedOperation 未授权操作。
中国站