数据湖计算 DLC
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据湖计算 DLC > API 文档 > 任务相关接口 > 查询spark作业列表

查询spark作业列表

最近更新时间：2024-03-12 01:25:55

我的收藏

本页目录：

1. 接口描述

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

查询spark作业列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSparkAppJobs。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
SortBy 否 String 返回结果按照该字段排序
示例值：create-time
Sorting 否 String 正序或者倒序，例如：desc
示例值：desc
Filters.N 否 Array of Filter 过滤条件，如下支持的过滤类型，传参Name应为其一:spark-job-name（作业名称），spark-job-id（作业id），spark-app-type（作业类型，1：批任务，2：流任务，4：SQL作业），user-name（创建人），key-word（作业名称或ID关键词模糊搜索）
StartTime 否 String 更新时间起始点，支持格式：yyyy-MM-dd HH:mm:ss
示例值：2022-01-01 00:00:00
EndTime 否 String 更新时间截止点，支持格式：yyyy-MM-dd HH:mm:ss
示例值：2022-01-02 00:00:00
Offset 否 Integer 查询列表偏移量, 默认值0
示例值：0
Limit 否 Integer 查询列表限制数量, 默认值100
示例值：10

3. 输出参数

参数名称 类型 描述
SparkAppJobs Array of SparkJobInfo spark作业列表详情
TotalCount Integer spark作业总数
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询spark作业列表

本接口用于查询spark作业列表

输入示例

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

{
    "Sorting": "desc",
    "SortBy": "create-time",
    "StartTime": "2022-01-01 00:00:00",
    "EndTime": "2022-01-01 00:00:00",
    "Filters": [
        {
            "Values": [
                "value"
            ],
            "Name": "key"
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "RequestId": "2ae4707a-9f72-44aa-9fd4-65cb739d6301",
        "SparkAppJobs": [],
        "TotalCount": 0
    }
}

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.InvalidSQL SQL解析失败。
InvalidParameter.InvalidTimeFormat 指定时间格式不合规，当前仅支持: YYYY-mm-dd HH:MM:SS
InvalidParameter.SparkJobFiltersKeyTypeNotMath 指定的Spark任务Filter.Key不匹配，当前仅支持: spark-app-type/user-name/spark-job-name/spark-job-id/key-word
InvalidParameter.SparkJobSortByTypeNotMatch 指定的Spark任务排序类型不匹配，当前仅支持create-time/update-time/user-name/data-engine-name
ResourceNotFound 资源不存在。
ResourceNotFound.BatchSQLTaskNotFound 指定的交互式SQL任务不存在
中国站