调用ListJobs接口查询批量操作任务列表。
权限说明
阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。
API | Action | 说明 |
ListJobs |
| 查询批量操作任务列表。 |
请求语法
GET /?batchJob&batchJobStatuses=JobStatuses&max-keys=MaxKeys&continuation-token=ContinuationToken HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
batchJobStatuses | 字符串 | 否 | Complete | 任务状态过滤条件,用于过滤查询结果。如果不设置此参数,则默认返回所有状态的任务。取值:Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended。支持取多个值,例如:Active | Cancelled | Cancelling 父节点:无 |
max-keys | 整数 | 否 | 100 | 指定分页查询时,返回任务的最大数量。取值范围:1~1000,默认值为100。 父节点:无 |
continuation-token | 字符串 | 否 | next-page-token-123 | 用于分页查询的分页标记。当您一次查询未能获取所有结果时,服务器会返回NextToken作为下一次查询的continuation-token,以继续获取结果。长度为1~1024个字符,包含A-Z、a-z、0-9、+、:、/、=、?、#、-、_。 父节点:无 |
请求头
此接口除支持公共请求头外,无特有请求头。更多信息,请参见公共请求头(Common Request Headers)。
响应元素
名称 | 类型 | 示例值 | 描述 |
ListJobsResult | 容器 | 无 | 响应的根节点。 父节点:无 子节点:NextToken、Jobs |
NextToken | 字符串 | next-page-token-456 | 下一页的token。如果一次查询未能获取所有结果,则该响应中会包含此元素,可作为下次查询的continuation-token以继续获取结果。 父节点:ListJobsResult |
Jobs | 容器 | 无 | 任务列表容器。 父节点:ListJobsResult 子节点:JobListDescriptor |
JobListDescriptor | 容器 | 无 | 任务描述信息。 父节点:Jobs 子节点:CreationTime、Description、JobId、Operation、Priority、ProgressSummary、Status、TerminationDate |
CreationTime | 时间戳 | 1749983400 | 任务的创建时间。 父节点:JobListDescriptor |
Description | 字符串 | 批量设置对象标签任务 | 任务的描述信息。 父节点:JobListDescriptor |
JobId | 字符串 | MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU= | 任务ID。 父节点:JobListDescriptor |
Operation | 字符串 | PutObjectTagging | 任务执行的操作。 父节点:JobListDescriptor |
Priority | 整数 | 10 | 任务优先级。 父节点:JobListDescriptor |
ProgressSummary | 容器 | 无 | 任务当前执行进度汇总。 父节点:JobListDescriptor 子节点:NumberOfTasksFailed、NumberOfTasksSucceeded、Timers、TotalNumberOfTasks |
NumberOfTasksFailed | 长整数 | 0 | 执行失败条目数。 父节点:ProgressSummary |
NumberOfTasksSucceeded | 长整数 | 1000 | 执行成功条目数。 父节点:ProgressSummary |
Timers | 容器 | 无 | 执行时间信息。 父节点:ProgressSummary 子节点:ElapsedTimeInActiveSeconds |
ElapsedTimeInActiveSeconds | 长整数 | 3600 | 执行消耗时间(秒)。 父节点:Timers |
TotalNumberOfTasks | 长整数 | 1000 | 总条目数。 父节点:ProgressSummary |
Status | 字符串 | Complete | 当前执行状态。取值:
父节点:JobListDescriptor |
TerminationDate | 时间戳 | 1749987000 | 终止时间。 父节点:JobListDescriptor |
响应头
此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)。
示例
请求示例
GET /?batchJob&batchJobStatuses=Complete&max-keys=10&continuation-token=next-page-token-123 HTTP/1.1 Host: oss-cn-hangzhou.aliyuncs.com Authorization: SignatureValue返回示例
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <ListJobsResult> <NextToken>next-page-token-456</NextToken> <Jobs> <JobListDescriptor> <CreationTime>1749983400</CreationTime> <Description>批量设置对象标签任务</Description> <JobId>MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=</JobId> <Operation>PutObjectTagging</Operation> <Priority>10</Priority> <ProgressSummary> <NumberOfTasksFailed>0</NumberOfTasksFailed> <NumberOfTasksSucceeded>1000</NumberOfTasksSucceeded> <Timers> <ElapsedTimeInActiveSeconds>3600</ElapsedTimeInActiveSeconds> </Timers> <TotalNumberOfTasks>1000</TotalNumberOfTasks> </ProgressSummary> <Status>Complete</Status> <TerminationDate>1749987000</TerminationDate> </JobListDescriptor> </Jobs> </ListJobsResult>