文档首页/数据治理中心 DataArts Studio/API参考/数据开发API（V1）/作业开发API/查询实时作业运行状态 - ShowJobStatus
更新时间：2026-03-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实时作业运行状态 - ShowJobStatus

功能介绍

查询指定实时作业的运行状态。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

  • URI格式

    GET /v1/{project_id}/jobs/{job_name}/status

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

    job_name

    是

    String

    作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。
    说明：
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。

响应参数

表3 参数说明

参数名

是否必选

参数类型

说明

name

是

String

解决方案名称。

nodes

否

列表数据结构

节点状态列表。

status

否

String

作业状态：

  • STARTING：启动中
  • NORMAL：正常
  • EXCEPTION：异常
  • STOPPING：停止中
  • STOPPED：停止

startTime

是

Date

启动时间。

endTime

否

Date

停止时间。

lastUpdateTime

否

Date

状态最后更新时间。

createUser

否

String

创建人。

lastModifiyUser

否

String

最后修改人。

表4 nodes字段数据结构说明

参数名

是否必选

参数类型

说明

name

是

String

节点名称。

status

否

String

节点状态：

  • STARTING：启动中
  • NORMAL：正常
  • EXCEPTION：异常
  • STOPPING： 停止中
  • STOPPED：停止

logPath

否

String

节点运行日志路径

type

是

String

节点类型：

  • Hive SQL：执行Hive SQL脚本
  • Spark SQL：执行Spark SQL脚本
  • DWS SQL：执行DWS SQL脚本
  • DLI SQL：执行DLI SQL脚本
  • Shell：执行Shell SQL脚本
  • CDM Job：执行CDM作业
  • DISTransferTask：创建DIS转储任务
  • CS Job：创建CloudStream作业，并启动作业
  • CloudTableManager节点：CloudTable表管理，参考创建和删除表。
  • OBSManager：OBS路径管理，包括创建和删除路径
  • RESTAPI：REST API请求
  • SMN： 发送短信或邮件
  • MRS Spark：执行MRS服务的Spark作业
  • MapReduce：执行MRS服务的MapReduce作业

lastInstanceStatus

是

String

上一次实例的执行状态。

speed

否

double

写入速率。

runningData

否

String

节点运行时内部存放的部分数据。

totalPutBytes

否

long

写入（输出）的总字节数。

bufferRecords

否

long

缓冲区中的记录数。

jobInstanceId

是

long

节点实例Id。

extendCounter

否

String

扩展计数器。

totalGetBytes

否

long

读取（输入）的总字节数 。

totalPutRecords

否

long

写入的总记录数。

totalGetRecords

否

long

读取的总记录数。

请求示例

查询实时作业job_sms作业运行状态以及各个节点运行状态。 
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_sms/status

响应示例

  • 成功响应 
    {
    "name": "job_sms",
    "nodes": [
        {
            "bufferRecords": 0,
            "jobInstanceId": 0,
            "LastInstanceStatus": "waiting",
            "name": "MRS_Flink_Job_8635",
            "speed": 0,
            "totalGetBytes": 0,
            "totalGetRecords": 0,
            "totalPutBytes": 0,
            "totalPutRecords": 0
        }
    ],
    "status": "NORMAL"
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.30100",
    "error_msg":"The job does not exists."
}
父主题： 作业开发API

相关文档