UpdateJobStatus

调用UpdateJobStatus接口更新指定批量操作任务的状态。

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM PolicyBucket Policy授予操作权限。

API

Action

说明

UpdateJobStatus

oss:UpdateJobStatus

更新批量操作任务的状态。

请求语法

POST /?batchJobStatus&batchJobId=xx&requestedJobStatus=RequestedJobStatus&statusUpdateReason=StatusUpdateReason HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

请求参数

名称

类型

是否必选

示例值

描述

batchJobId

字符串

MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

批量操作任务的ID。长度为44个字符,不包含短划线(-)和下划线(_),可以包含小写字母(a-z)、大写字母(A-Z)、数字(0-9)。

父节点:无

子节点:无

requestedJobStatus

字符串

Cancelled

请求更新的任务状态。状态更新会影响任务的执行流程。有效值:CancelledReady。任务当前状态处于Cancelled | Cancelling | Complete | Completing | Failed | Failing时,不能再设置为Cancelled;处于Suspended | Preparing的任务才能设置为Ready。

父节点:无

子节点:无

statusUpdateReason

字符串

可选

User requested cancellation

状态更新的原因。当requestedJobStatusReady时,此参数为可选项。原因说明的长度必须为1~256个字符。

父节点:无

子节点:无

请求头

此接口除支持公共请求头外,无特有请求头。更多信息,请参见公共请求头(Common Request Headers)

响应元素

名称

类型

示例值

描述

UpdateJobStatusResult

容器

响应的根节点。

父节点:无

子节点:JobId、Status、StatusUpdateReason

JobId

字符串

MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

任务ID。

父节点:UpdateJobStatusResult

子节点:无

Status

字符串

Cancelling

更新后的任务状态。

父节点:UpdateJobStatusResult

子节点:无

StatusUpdateReason

字符串

User requested cancellation

状态更新的原因。

父节点:UpdateJobStatusResult

子节点:无

响应头

此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)

示例

  • 请求示例

    POST /?batchJobStatus&batchJobId=MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=&requestedJobStatus=Cancelled&statusUpdateReason=User%20requested%20cancellation HTTP/1.1
    Host: oss-cn-hangzhou.aliyuncs.com
    Authorization: OSS LTAI4Fw2Nb3o4f5a3a1f****:2s98lj9n796c9kdc6b5f4l5b****
  • 响应示例

    HTTP/1.1 200 OK
    <?xml version="1.0" encoding="UTF-8"?>
    <UpdateJobStatusResult>
       <JobId>MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=</JobId>
       <Status>Cancelling</Status>
       <StatusUpdateReason>User requested cancellation</StatusUpdateReason>
    </UpdateJobStatusResult>