# 查询所有作业 - ListSqlJobs #### 功能介绍 该API用于查询当前project下的所有作业的信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DLI/doc?api=ListSqlJobs)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key | 别名 Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | dli:jobs:list | list | jobs \* | - | - | - | | dli:jobs:list | list | - | - [g:RequestTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:TagKeys](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI - URI格式： GET /v1.0/{project_id}/jobs - 参数说明 表1URI 参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 示例: 48cc2c48765f481480c7db940d6409d1 **约束限制：** 无 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 无 | 表2query参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | page-size | 否 | Integer | **参数解释:** 每页显示的最大作业个数 示例: 5 **约束限制:** 无 **取值范围:** \[1, 100\] **默认取值:** 50 | | current-page | 否 | Integer | **参数解释:** 当前页码，默认为第一页。 **约束限制:** 无 **取值范围:** \[1, 100\] **默认取值:** 1 | | start | 否 | Long | **参数解释:** 用于查询开始时间在该时间点之后的作业。 **约束限制:** 时间格式为unix时间戳，单位：毫秒。 **取值范围:** 无 **默认取值:** 无 | | end | 否 | Long | **参数解释:** 用于查询开始时间在该时间点之前的作业。 **约束限制:** 时间格式为unix时间戳，单位：毫秒。 **取值范围:** 无 **默认取值:** 无 | | job-type | 否 | String | **参数解释:** 指定查询的作业类型。包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE，若要查询所有类型的作业，则传入ALL。 job-type适用于单个类型查询，但是支持传入ALL。 与job_types共存的场景按两者参数的交集取值。 **约束限制:** 无 **取值范围:** - DDL：数据定义类型的任务（如 CREATE、ALTER、DROP） - DCL：数据控制类型的任务（如 GRANT、REVOKE 等权限操作） - IMPORT：数据导入任务（从外部源加载数据） - EXPORT：数据导出任务（将数据输出到外部系统） - QUERY：查询任务（如 SELECT 语句） - INSERT：数据插入任务（如 INSERT 语句） - DATA_MIGRATION：数据迁移任务（跨库/跨集群数据迁移） - UPDATE：数据更新任务（如 UPDATE 语句） - DELETE：数据删除任务（如 DELETE 语句） - RESTART_QUEUE：重启队列任务（恢复暂停或失败的任务队列） - SCALE_QUEUE：队列扩缩容任务（动态调整队列资源） **默认取值:** 无 | | job_types | 否 | Array\[string\] | **参数解释:** 指定查询的任务类型列表，可选值包括DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、UPDATE、DELETE。 job_types适用于多个类型查询。与job-type共存的场景按两者参数的交集取值。 **约束限制:** 无 **取值范围:** - DDL：数据定义类型的任务（如 CREATE、ALTER、DROP 等操作） - DCL：数据控制类型的任务（如 GRANT、REVOKE 等权限操作） - IMPORT：数据导入任务（如从文件或外部源导入数据） - EXPORT：数据导出任务（如将数据导出到文件或外部系统） - QUERY：查询任务（如 SELECT 语句） - INSERT：数据插入任务（如 INSERT 语句） - UPDATE：数据更新任务（如 UPDATE 语句） - DELETE：数据删除任务（如 DELETE 语句） **默认取值:** 无 | | job-status | 否 | String | **参数解释:** 指定查询的作业状态。 **约束限制:** 无 **取值范围:** - RUNNING：运行中 - SCALING：规格变更中 - LAUNCHING：提交中 - FINISHED：已完成 - FAILED：已失败 - CANCELLED：已取消 **默认取值:** 无 | | job-id | 否 | String | **参数解释:** 指定查询的作业ID。可通过[提交SQL作业（推荐） - CreateSqlJob](https://support.huaweicloud.com/api-dli/dli_02_0102.html)获取。 **约束限制:** 无 **取值范围:** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值:** 无 | | queue_name | 否 | String | **参数解释:** 指定queue_name作为作业过滤条件，查询在指定queue上运行的作业。 **约束限制:** 无 **取值范围:** 无 **默认取值:** 无 | | sql_pattern | 否 | String | **参数解释:** 指定sql片段作为作业过滤条件，不区分大小写。 **约束限制:** 无 **取值范围:** 无 **默认取值:** 无 | | order | 否 | String | **参数解释:** 指定作业排序方式。 **约束限制:** 无 **取值范围:** - duration_desc：作业运行时长降序 - duration_asc：作业运行时长升序 - start_time_desc：作业提交时间降序 - start_time_asc：作业提交时间升序 **默认取值:** 默认为start_time_desc：作业提交时间降序 | | engine_type | 否 | String | **参数解释:** 引擎类型。当前仅支持配置Spark引擎。 **约束限制:** 无 **取值范围:** - spark：代表Spark引擎。 了解引擎的详细类型和说明请参考[DLI简介](https://support.huaweicloud.com/productdesc-dli/dli_01_0378.html)。 **默认取值:** 无 | | owner | 否 | String | **参数解释:** 提交作业的用户。 **约束限制:** 无 **取值范围:** 无 **默认取值:** 无 | | tags | 否 | String | 指定作业标签作为过滤条件，支持多标签过滤，格式为"key=value"。 **参数解释:** 指定作业标签作为过滤条件，支持多标签过滤，格式为"key=value"。 **约束限制:** 当前只支持所有tags值整体的模糊查询，不支持精确查询。 **取值范围:** - 单标签场景： 例如，GET /v1.0/{project_id}/jobs?tags=k1%3Dv1 其中，"="需要转义为"%3D"，"k1"为标签键，"v1"为标签值。 - 多标签场景： 如果涉及到多个标签的场景，则多个标签之间需要通过","号分隔，","号需要转义为"%2C"，例如：GET /v1.0/{project_id}/jobs?tags=k1%3Dv1%2Ck2%3Dv2 其中，"="需要转义为"%3D"，"k1"为标签键1，"v1"为标签值1，"k2"为标签键2，"v2"为标签值2。 **默认取值:** 无 | ![](https://support.huaweicloud.com/api-dli/public_sys-resources/note_3.0-zh-cn.png) 带入query参数的URL示例如下： GET /v1.0/{project_id}/jobs?page-size=*{size}* \¤t-page=*{page_number}* \&start=*{start_time}* \&end=*{end_time}* \&job-type=*{QUERY}* \&queue_name=*{test}* \&order=*{duration_desc}* #### 请求消息 无请求参数。 #### 响应消息 表3响应参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | is_success | 是 | Boolean | 执行请求是否成功。"true"表示请求执行成功。 | | message | 是 | String | 系统提示信息，执行成功时，信息可能为空。 | | job_count | 是 | Integer | 作业总个数。 | | jobs | 是 | Array of Objects | 作业信息。具体参数请参见[表4]。 | 表4jobs参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释:** 作业ID。可通过[提交SQL作业（推荐） - CreateSqlJob](https://support.huaweicloud.com/api-dli/dli_02_0102.html)获取。 | | job_type | 是 | String | **参数解释:** 查询的作业类型。 **取值范围:** - DDL：数据定义类型的任务（如 CREATE、ALTER、DROP） - DCL：数据控制类型的任务（如 GRANT、REVOKE 等权限操作） - IMPORT：数据导入任务（从外部源加载数据） - EXPORT：数据导出任务（将数据输出到外部系统） - QUERY：查询任务（如 SELECT 语句） - INSERT：数据插入任务（如 INSERT 语句） - DATA_MIGRATION：数据迁移任务（跨库/跨集群数据迁移） - UPDATE：数据更新任务（如 UPDATE 语句） - DELETE：数据删除任务（如 DELETE 语句） - RESTART_QUEUE：重启队列任务（恢复暂停或失败的任务队列） - SCALE_QUEUE：队列扩缩容任务（动态调整队列资源） - ALL：代表查询所有类型。 | | queue_name | 是 | String | **参数解释:** 作业提交的队列。 **取值范围:** 无 | | owner | 是 | String | **参数解释:** 提交作业的用户。 **取值范围:** 无 | | start_time | 是 | Long | **参数解释:** 作业开始的时间。是单位为"毫秒"的时间戳。 **取值范围:** 无 | | duration | 是 | Long | **参数解释:** 作业运行时长，单位毫秒。 **取值范围:** 无 | | status | 是 | String | **参数解释:** 此作业的当前状态。 **取值范围:** - RUNNING：运行中 - SCALING：规格变更中 - LAUNCHING：提交中 - FINISHED：已完成 - FAILED：已失败 - CANCELLED：已取消 | | input_row_count | 否 | Long | **参数解释:** Insert作业执行过程中扫描的记录条数。 **取值范围:** 无 | | bad_row_count | 否 | Long | **参数解释:** Insert作业执行过程中扫描到的错误记录数。 **取值范围:** 无 | | input_size | 是 | Long | **参数解释:** 作业执行过程中扫描文件的大小。 **取值范围:** 无 | | result_count | 是 | Integer | **参数解释:** 当前作业返回的结果总条数或insert作业插入的总条数。 **取值范围:** 无 | | database_name | 否 | String | **参数解释:** 记录其操作的表所在的数据库名称。类型为Import和Export作业才有"database_name"属性。 **取值范围:** 无 | | table_name | 否 | String | **参数解释:** 记录其操作的表名称。类型为Import和Export作业才有"table_name"属性。 **取值范围:** 无 | | with_column_header | 否 | Boolean | **参数解释:** Import类型的作业，记录其导入的数据是否包括列名。 **取值范围:** 无 | | detail | 是 | String | **参数解释:** SQL查询的相关列信息的Json字符串。 **取值范围:** 无 | | engine_type | 否 | String | **参数解释:** 显示队列配置的引擎类型。 **取值范围:** - spark：代表配置为Spark引擎 了解引擎的详细类型和说明请参考[DLI简介](https://support.huaweicloud.com/productdesc-dli/dli_01_0378.html)。 | | statement | 是 | String | **参数解释:** 作业执行的SQL语句。 **取值范围:** 无 | | message | 否 | String | **参数解释:** 系统提示信息。 **取值范围:** 无 | | end_time | 否 | Long | **参数解释:** 作业结束的时间。是单位为"毫秒"的时间戳。 **取值范围:** 无 | | tags | 否 | Array of Objects | **参数解释:** 作业标签。具体请参考[表5]。 **取值范围:** 无 | | output_byte | 否 | String | **参数解释:** 作业的输出字节数。 **取值范围:** 无 | | cpu_cost | 否 | String | **参数解释:** 作业的CPU累计使用量。 **取值范围:** 无 | | result_format | 否 | String | **参数解释:** 作业结果的存储格式，当前只支持csv。 **取值范围:** 无 | | result_path | 否 | String | **参数解释:** 作业结果的OBS路径。 **取值范围:** 无 | | execution_details_path | 否 | String | **参数解释:** 作业执行计划的存储路径。 例如：obs://bucketName/jobs/execution_details/xxx/2023/11/10/xxx **取值范围:** 无 | 表5tags参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签的键。 **取值范围：** 无 | | value | 是 | String | **参数解释：** 标签的值。 **取值范围：** 无 | #### 请求示例 无 #### 响应示例 ``` { "is_success": true, "message": "", "job_count": 1, "jobs": [ { "detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"age\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", "duration": 17731, "end_time": 1502349821460, "input_size": 0, "job_id": "37286cc7-0508-4ffd-b636-951c8a5c75de", "job_type": "QUERY", "message": "", "owner": "tenant1", "queue_name": "queue1", "result_count": 3, "start_time": 1502349803729, "statement": "select * from t_json_002", "status": "FINISHED", "with_column_header": false } ] } ``` #### 状态码 状态码如[表6]所示。 表6状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | | 400 | 请求错误。 | | 500 | 内部服务器错误。 | #### 错误码 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。