更新时间:2025-08-14 GMT+08:00
分享

查询批处理作业状态

功能介绍

该API用于查询批处理作业的状态。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v2.0/{project_id}/batches/{batch_id}/state

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    说明

    project_id

    参数解释:

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    示例: 48cc2c48765f481480c7db940d6409d1

    约束限制:

    取值范围:

    只能由英文字母和数字组成,且长度为[1-64]个字符。

    默认取值:

    batch_id

    参数解释:

    批处理作业的ID。获取方式请参考查询批处理作业列表响应参数中的appId。

    示例: 0a324461-d9d9-45da-a52a-3b3c7a3d809e

    约束限制:

    匹配正则表达式'^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'的字符串。

    取值范围:

    默认取值:

请求消息

无请求参数。

响应消息

表2 响应参数说明

参数名称

是否必选

参数类型

说明

id

String

参数解释:

批处理作业的ID,采用UUID(通用唯一识别码)格式。

取值范围:

state

String

参数解释:

批处理作业的状态。

取值范围:

  • starting:正在启动
  • running:正在执行任务
  • dead:session已退出
  • success:session停止成功
  • recovering:正在恢复

请求示例

响应示例

{"id":"0a324461-d9d9-45da-a52a-3b3c7a3d809e","state":"Success"}

状态码

状态码如表3所示。

表3 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

相关文档