文档首页/ 智能数据湖 AI DataLake/ API参考/ Flink相关API/ Flink作业管理/ 查询Flink作业状态 - ShowFlinkJobState
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询Flink作业状态 - ShowFlinkJobState

功能介绍

查询Flink作业的运行状态。此接口为同步接口，响应中包含作业当前状态。

可通过查看Flink作业详情接口获取作业完整信息，或通过查询Flink作业事件详情列表接口获取作业运行事件。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/state

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID，用于资源隔离。获取方法请参见获取工作空间ID。

约束限制：不涉及。

取值范围：只能由英文字母、数字及中划线组成，且长度为32~36个字符。

默认取值：不涉及。

job_id

是

String

参数解释：Flink作业ID，用于唯一标识一个Flink作业，可通过查询Flink作业列表接口获取。

约束限制：不涉及。

取值范围：采用UUIDv7格式，固定36个字符。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，用于接口认证鉴权，可通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：Flink作业ID。

取值范围：UUIDv7格式，固定36位，由英文小写字母、数字及中划线组成。

state

String

参数解释：作业当前状态。

取值范围：

  • CREATED：已创建。

  • STARTING：启动中。

  • RUNNING：运行中。

  • CANCELLING：停止中。

  • FAILED：已失败。

  • CANCELLED：已停止。

  • FINISHED：已完成。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

请求示例

查询指定Flink作业的当前运行状态，用于监控作业进度和判断作业是否完成。

GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/state

响应示例

状态码：200

{
  "job_id" : "019f609a-e90c-xxxx-xxxx-a4ec9018e7f2",
  "state" : "RUNNING"
}

状态码：400

{
  "error_code" : "AIDataLake.01011001",
  "error_msg" : "Invalid parameter",
  "solution_msg" : "Please check the input parameters according to the documentation."
}

状态码：401

{
  "error_code" : "AIDataLake.01011003",
  "error_msg" : "Auth Token not exists in header",
  "solution_msg" : "Please check if auth Token is included in the request header."
}

状态码：403

{
  "error_code" : "AIDataLake.01011005",
  "error_msg" : "Current account has no permission",
  "solution_msg" : "Please connect administrators to add permission."
}

状态码：404

{
  "error_code" : "AIDataLake.01051001",
  "error_msg" : "Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 does not exist",
  "solution_msg" : "Please check if Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 is entered correctly or has been deleted."
}

状态码：500

{
  "error_code" : "AIDataLake.01010001",
  "error_msg" : "Internal system error",
  "solution_msg" : "Contact operations for analysis."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

认证失败。

403

权限不足。

404

Flink作业不存在。

500

系统内部错误。
父主题： Flink作业管理

相关文档