DescribeJobStatus - DescribeJobStatus_Serverless 应用引擎(SAE)-阿里云帮助中心

调用DescribeJobStatus接口查询任务状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sae:DescribeJobStatus		全部资源 *	无	无

请求语法

GET /pop/v1/sam/job/describeJobStatus HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	任务模板 ID。	e1a7a07-abcb-4652-a1d3-2d57f415****
JobId	string	否	任务 ID。	event-b798157b-40a2-4388-b578-71fb897103-

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	53F15A18-8079-5992-810C-0211A5AE****
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0b1639af16575057857241351e****
Data	object	返回数据。
JobId	string	任务 ID。	event-b798157b-40a2-4388-b578-71fb897103-
Active	long	正在运行的实例数。	0
Succeeded	long	运行成功的实例数。	3
Failed	long	运行失败的实例数。	0
StartTime	long	任务的创建时间。	1657522800
CompletionTime	long	任务执行的完成时间。	1657522839
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
State	string	任务的运行状态。取值说明如下： 0：未执行。 1：执行成功。 2：执行失败。 3：正在执行。	1
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	查询任务状态是否成功。取值说明如下： true：查询成功。 false：查询失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "JobId": "event-b798157b-40a2-4388-b578-71fb897103**-**",
    "Active": 0,
    "Succeeded": 3,
    "Failed": 0,
    "StartTime": 1657522800,
    "CompletionTime": 1657522839,
    "Message": "success",
    "State": "1"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史