查询Spark作业的状态 - ShowSparkJobState

功能介绍

查询Spark作业的状态，此接口为同步接口。可通过作业ID查询Spark作业的当前执行状态，包括排队中、运行中、已成功、已失败等状态，调用后立即返回作业当前状态。

调用方法

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间ID，用于资源隔离。约束限制：不涉及。取值范围：只能由英文字母、数字及中划线组成，且长度为32~36个字符。默认取值：不涉及。
job_id	是	String	参数解释：Spark作业ID，用于唯一标识一个Spark作业。约束限制：不涉及。取值范围：只能由十六进制字符、中划线及下划线组成，且长度为1~64个字符。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。约束限制：不涉及。取值范围：长度不超过65534个字符。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
job_id	String	参数解释：Spark作业ID，用于唯一标识一个Spark作业。取值范围：采用UUID格式，长度为36个字符，例如：6c98db52-cac2-4ff1-9a91-b7793e95557d。
state	String	参数解释：Spark作业的状态。取值范围： QUEUED：排队中。 PENDING：启动中。 RUNNING：运行中。 CANCELING：取消中。 CANCELED：已取消。 FAILED：运行失败。 QUEUED_TIMEOUT：排队超时。 RUNNING_TIMEOUT：运行超时。 SUCCEED：运行成功。

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，用于标识具体的错误类型。取值范围：长度为0~64个字符。
error_msg	String	参数解释：错误描述信息，用于说明错误原因。取值范围：长度为0~512个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为0~4096个字符。

状态码：401

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，用于标识具体的错误类型。取值范围：长度为0~64个字符。
error_msg	String	参数解释：错误描述信息，用于说明错误原因。取值范围：长度为0~512个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为0~4096个字符。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，用于标识具体的错误类型。取值范围：长度为0~64个字符。
error_msg	String	参数解释：错误描述信息，用于说明错误原因。取值范围：长度为0~512个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为0~4096个字符。

状态码：500

表7 响应Body参数
参数	参数类型	描述
-	String	错误信息。

请求示例

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

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

响应示例

状态码：200

查询成功。

{
  "job_id" : "6c98db52-cac2-4ff1-9a91-b7793e95557d",
  "state" : "RUNNING"
}

状态码：400

请求参数错误。

{
  "error_code" : "AIDataLake.01011001",
  "error_msg" : "Invalid parameter name",
  "solution_msg" : "Please check the input parameters according to the documentation(name for spark job)."
}

状态码：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."
}