调用SuspendJob接口暂停任务。

调试

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

请求头

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

请求语法

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

请求参数

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

任务模板ID。
Suspend Boolean Query 是 true

是否暂停任务模板。

返回数据

名称 类型 示例值 描述
RequestId String 67DD9A98-9CCC-5BE8-8C9E-B45E72F4****

请求ID。
Message String success

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

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

调用链ID，用于精确查询调用信息。
Data String {success: true}

执行是否成功。
ErrorCode String 空

错误码。取值说明如下：

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

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

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

执行任务是否成功。取值说明如下：

  • true：执行成功。
  • false：执行失败。

示例

请求示例

GET /pop/v1/sam/job/suspendJob?AppId=ee1a7a07-abcb-4652-a1d3-2d57f415****&Suspend=true HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

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

<SuspendJobResponse>
    <RequestId>67DD9A98-9CCC-5BE8-8C9E-B45E72F4****</RequestId>
    <Message>success</Message>
    <TraceId>0b87b7e716575071334387401e****</TraceId>
    <Data>{success: true}</Data>
    <Code>200</Code>
    <Success>true</Success>
</SuspendJobResponse>

JSON格式

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

{
  "RequestId" : "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Message" : "success",
  "TraceId" : "0b87b7e716575071334387401e****",
  "Data" : "{success: true}",
  "Code" : "200",
  "Success" : true
}

错误码

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

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