暂停作业

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SuspendJobs

系统规定参数。取值:SuspendJobs。

All Boolean false

过滤条件,是否暂停所有

InstanceId String af81a389-91f0-4157-8d82-720edd02b66a

实例id

ScenarioId String 4b6dd926-3cc3-4111-a333-15d9b006fe81

过滤条件,场景id

JobGroupId String 6b3ea2a1-32b3-4041-842b-9bde5de9dda0

过滤条件,作业组id

JobId.N RepeatList 11994321-e6bc-47bb-8b1c-8eef8f2f768b

作业id

JobReferenceId.N RepeatList de3ab269-6746-477c-b13d-bd49f13202c2

作业的第三方id

返回数据

名称 类型 示例值 描述
Code String OK

响应码

HttpStatusCode Integer 200

Http状态码

Message String Success

响应信息

RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求ID

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=SuspendJobs
&All=false
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&<公共请求参数>

正常返回示例

XML 格式

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>

JSON 格式

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
404 NotExist.Instance The specified Instance does not exist. 指定的实例不存在。
404 NotExist.JobGroup The specified JobGroup does not exist. 指定的任务组不存在。
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试,如果多次重试报错请提交工单。

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