调用DescribeJobHistory接口查询任务记录。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。更多信息，请参见公共请求和返回头。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query 是 e1a7a07-abcb-4652-a1d3-2d57f415****

任务模板ID。
CurrentPage Long Query 否 1

当前页码。
PageSize Long Query 否 20

分页查询时设置的每页数量。取值范围[0,10000]。
State String Query 否 1

任务的运行状态。取值说明如下：

  • 0：未执行。
  • 1：执行成功。
  • 2：执行失败。
  • 3：正在执行。

返回数据

名称 类型 示例值 描述
RequestId String 53F15A18-8079-5992-810C-0211A5AE****

请求ID。
Message String success

附加信息。取值说明如下：

  • 请求正常，返回success。
  • 请求异常，返回具体异常错误码。
TraceId String 0b1639af16575057857241351e****

调用链ID，用于精确查询调用信息。
Data Object

返回数据。
CurrentPage Long 1

当前页码。
TotalSize Long 20

任务总数。
PageSize Long 20

分页查询时设置的每页数量。取值范围[0,10000]。
Jobs Array of job

任务列表。
JobId String manual-3db7a8fa-5d40-4edc-92e4-49d50eab****

任务ID。
Active Long 0

正在运行的实例数。
Succeeded Long 3

运行成功的实例数。
Failed Long 0

运行失败的实例数。
StartTime Long 1657522800

任务的创建时间。
CompletionTime Long 1657522839

任务执行的完成时间。
Message String 空

任务执行异常时的附加信息。
State String 1

任务的运行状态。取值说明如下：

  • 0：未执行。
  • 1：执行成功。
  • 2：执行失败。
  • 3：正在执行。
ErrorCode String 空

错误码。取值说明如下：

  • 请求成功：不返回ErrorCode字段。
  • 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码目录。
Code String 200

接口状态或POP错误码。取值说明如下：

  • 2xx：成功。
  • 3xx：重定向。
  • 4xx：请求错误。
  • 5xx：服务器错误。
Success Boolean true

查询任务状态是否成功。取值说明如下：

  • true：查询成功。
  • false：查询失败。

示例

请求示例

GET /pop/v1/sam/job/describeJobHistory?AppId=e1a7a07-abcb-4652-a1d3-2d57f415****&CurrentPage=1&PageSize=20&State=1 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeJobHistoryResponse>
    <RequestId>53F15A18-8079-5992-810C-0211A5AE****</RequestId>
    <Message>success</Message>
    <TraceId>0b1639af16575057857241351e****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <TotalSize>20</TotalSize>
        <PageSize>20</PageSize>
        <Jobs>
            <JobId>manual-3db7a8fa-5d40-4edc-92e4-49d50eab****</JobId>
            <Active>0</Active>
            <Succeeded>3</Succeeded>
            <Failed>0</Failed>
            <StartTime>1657522800</StartTime>
            <CompletionTime>1657522839</CompletionTime>
            <State>1</State>
        </Jobs>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeJobHistoryResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "53F15A18-8079-5992-810C-0211A5AE****",
  "Message" : "success",
  "TraceId" : "0b1639af16575057857241351e****",
  "Data" : {
    "CurrentPage" : 1,
    "TotalSize" : 20,
    "PageSize" : 20,
    "Jobs" : [ {
      "JobId" : "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
      "Active" : 0,
      "Succeeded" : 3,
      "Failed" : 0,
      "StartTime" : 1657522800,
      "CompletionTime" : 1657522839,
      "State" : "1"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

错误码

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

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