# 查询作业状态 - ShowSqlJobStatus #### 功能介绍 该API用于在作业提交后查询作业状态。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DLI/doc?api=ShowSqlJobStatus)中调试该接口。 #### 授权信息 账号具备所有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:get | read | jobs \* | - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI - URI格式： GET /v1.0/{project_id}/jobs/{job_id}/status - 参数说明 表1URI 参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 示例: 48cc2c48765f481480c7db940d6409d1 **约束限制：** 无 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 无 | | job_id | 是 | String | **参数解释：** 作业ID。获取方式请参考[查询作业详细信息 - ShowSqlJobDetail](https://support.huaweicloud.com/api-dli/dli_02_0022.html)。 示例: 6d2146a0-c2d5-41bd-8ca0-ca9694ada992 **约束限制：** 无 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 无 | #### 请求消息 无请求参数。 #### 响应消息 表2响应参数 | 参数名称 | 参数类型 | 说明 | |:---|:---|:---| | is_success | Boolean | **参数解释：** 执行请求是否成功。 **取值范围：** "true"：表示请求执行成功。 "false"：表示请求执行失败。 | | message | String | **参数解释：** 系统提示信息，执行成功时，该值为空。 **取值范围：** 无 | | job_id | String | **参数解释：** 作业ID。 **取值范围：** 无 | | job_type | String | **参数解释：** 作业类型。 **取值范围：** 包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE。 - DDL：创建修改删除元数据类型的作业 - DCL：权限授权与回收类型的作业 - IMPORT：外部数据入库类型的作业 - EXPORT：数据导出到外部类型的作业 - QUERY：运行查询语句类型的作业 - INSERT：向表追加新数据类型的作业 - DATA_MIGRATION：跨源迁移数据类型的作业 - UPDATE：更新表数据的作业 - DELETE：删除指定表数据的作业 - RESTART_QUEUE：重启指定队列的作业 - SCALE_QUEUE：对指定队列扩容/缩容的作业 | | job_mode | String | **参数解释：** 作业执行模式。 **取值范围：** - async：异步 - sync：同步 | | 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和QUERY的作业才有"database_name"属性。 **取值范围：** 无 | | table_name | String | **参数解释：** 记录其操作的表名称。类型为IMPORT、EXPORT和QUERY的作业才有"table_name"属性。 **取值范围：** 无 | | detail | String | **参数解释：** 相关列信息的Json字符串。 **默认取值：** 无 | | statement | String | **参数解释：** 作业执行的SQL语句。 **取值范围：** 无 | | tags | Array of objects | **参数解释：** 作业的标签。具体请参考[表3]。 **取值范围：** 无 | | user_conf | String | **参数解释：** 用户提交SQL作业时候配置的Spark参数。 **取值范围：** 用户以"key/value"的形式设置用于此作业的配置参数。目前支持的配置项请参考[表3](https://support.huaweicloud.com/api-dli/dli_02_0102.html#dli_02_0102__table334825142314)。 | | result_format | String | **参数解释：** 作业结果的存储格式。 **取值范围：** 当前只支持csv。 | | result_path | String | **参数解释：** 作业结果的OBS路径。 **取值范围：** 无 | | execution_details_path | String | **参数解释：** 查询作业执行计划OBS路径。 **取值范围：** 无 | 表3tags参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签的键。 **取值范围：** 无 | | value | 是 | String | **参数解释：** 标签的值。 **取值范围：** 无 | #### 请求示例 无 #### 响应示例 ``` { "is_success": true, "message": "", "job_id": "208b08d4-0dc2-4dd7-8879-ddd4c020d7aa", "job_type": "QUERY", "job_mode":"async", "queue_name": "default", "owner": "test", "start_time": 1509335108918, "duration": 2523, "status": "FINISHED", "input_size": 22, "result_count": 4, "database_name":"dbtest", "table_name":"tbtest", "detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"id\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}", "statement": "select * from t1" } ``` #### 状态码 状态码如[表4]所示。 表4状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | | 400 | 请求错误。 | | 500 | 内部服务器错误。 | #### 错误码 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。