全部文档
当前文档

热搜词推荐

云服务器 虚拟私有网络 边缘节点计算 对等连接

共搜索到 0 条结果

暂无内容

如果没有找到您期望的内容，请尝试其他搜索词

文档中心

对象存储(KS3)

查看更多结果
未找到含当前关键字的文档标题
页面目录
全部展开全部收起
未找到含该关键词的产品
文档中心 对象存储(KS3) API文档 批量处理 ListJobs

ListJobs

最近更新时间：2025-07-25 16:25:05

该接口用于列出批量处理任务。

任务执行完成90天后，将会被自动清除，无法列出。

权限描述

使用该接口的用户，必须是主账号或具有ks3:ListJobs权限。

请求

请求示例

GET /?jobs&jobStatuses=<JobStatuses>&maxResults=<MaxResults>&nextToken=<NextToken> HTTP/1.1
Host: ks3-cn-beijing.ksyuncs.com
Date: {date}
Authorization: {SignatureValue}

请求参数

参数

描述

是否必选

jobStatuses

所需查询的任务状态信息。可选的任务状态包括：

  • New：表示批量处理任务刚被创建，任务正在解析中。

  • Active：表示批量操作任务正在进行中。

  • Complete：表示批量操作任务已完成，处于最终状态。

如果未指定任务状态，KS3将返回所有状态的任务。如果指定了任务状态，KS3仅返回指定状态的任务。

否

maxResults

返回任务数量最大值。可配合nextToken参数实现分页返回。

  • 取值范围：1-1000

  • 默认值：1000

1. 如果配置了该参数，单次返回的任务数量最多不会超过该值，如果没有配置该参数，默认最多返回1000条任务。

2. 最终将按照JobId顺序进行返回。

否

nextToken

分页符。

  • 取值范围：1-64字节

List操作结束后将返回本次任务列表的最后一个JobId作为nextToken，在下一次List操作时传入该nextToken值，即可接续上一次List的内容进行List，用于分页。

否

请求头

该接口只使用公共请求头。

请求体

该请求不使用请求体。

响应

响应头

该接口只返回公共响应头部。

响应体

响应体为一段描述所列举批量处理任务具体信息的XML：

<ListJobsResult>
    <Jobs>
        <Member>
            <CreationTime>string</CreationTime>
            <Description>string</Description>
            <JobId>string</JobId>
            <Operation>string</Operation>
            <Priority>integer</Priority>
            <ProgressSummary>
                <NumberOfTasksFailed>integer</NumberOfTasksFailed>
                <NumberOfTasksSucceeded>integer</NumberOfTasksSucceeded>
                <TotalNumberOfTasks>integer</TotalNumberOfTasks>
            </ProgressSummary>
            <Status>string</Status>
            <TerminationDate>string</TerminationDate>
        </Member>
        <Member>
            <CreationTime>string</CreationTime>
            <Description>string</Description>
            <JobId>string</JobId>
            <Operation>string</Operation>
            <Priority>integer</Priority>
            <ProgressSummary>
                <NumberOfTasksFailed>integer</NumberOfTasksFailed>
                <NumberOfTasksSucceeded>integer</NumberOfTasksSucceeded>
                <TotalNumberOfTasks>integer</TotalNumberOfTasks>
            </ProgressSummary>
            <Status>string</Status>
            <TerminationDate>string</TerminationDate>
        </Member>
    </Jobs>
    <NextToken></NextToken>
</ListJobsResult>

响应体内具体元素描述如下所示：

名称

描述

ListJobsResult

包含所列举批量处理规则信息的容器。

  • 类型：容器

Jobs

包含KS3返回的多个批量处理任务信息。

  • 类型：容器

  • 父节点：ListJobsResult

Member

包含KS3返回的单个批量处理任务信息。

  • 类型：容器

  • 父节点：Jobs

CreationTime

任务创建时间。

  • 类型：String

  • 父节点：Member

采用ISO 8601日期和时间表示法，示例：2024-08-17T17:04:52Z，加8小时表示中国北京时间。

Description

任务描述。

  • 类型：String

  • 父节点：Member

JobId

任务ID。规则创建成功后，KS3会自动返回该参数，每个规则对应唯一的任务ID。

  • 类型：String

  • 父节点：Member

Operation

具体操作。支持批量解冻、批量修改ACL、批量删除操作。

  • 取值：KS3RestoreObject、KS3PutObjectAcl、KS3DeleteObject

  • 类型：String

  • 父节点：Member

Priority

任务优先级。取值越大表示任务执行的优先级越高。

  • 取值范围：0-2147483647

  • 类型：Int

  • 父节点：Member

ProgressSummary

任务执行状况概述。描述该批量处理任务中所执行的操作总数，成功的操作数量以及失败的操作数量。

  • 类型：容器

  • 父节点：Member

NumberOfTasksFailed

当前失败的操作数。

  • 类型：Long

  • 父节点：ProgressSummary

NumberOfTasksSucceeded

当前成功的操作数。

  • 类型：Long

  • 父节点：ProgressSummary

TotalNumberOfTasks

总操作数。

  • 类型：Long

  • 父节点：ProgressSummary

Status

任务执行的当前状态。合法参数值包括：New、Active、Complete。

  • 类型：String

  • 父节点：Member

New：批量处理任务刚被创建，任务正在解析中。

Active：批量操作任务进行中。

Complete：批量操作任务已完成，处于最终状态。

TerminationDate

任务终止的时间。

  • 类型：String

  • 父节点：Member

采用ISO 8601日期和时间表示法，示例：2024-08-17T17:04:52Z，加8小时表示中国北京时间。

NextToken

分页符。

  • 取值范围：1-64字节

  • 类型：String

  • 父节点：ListJobsResult

1. 如果全部任务已List完，则不返回该参数。

2. List操作结束后将返回本次任务列表的最后一个JobId作为nextToken，在下一次List操作时传入该nextToken值，即可接续上一次List的内容进行List，用于分页。

示例

请求示例

GET /?jobs&jobStatuses=Complete&maxResults=500&nextToken=184ce261-18af-5e3d-3e30-253723cfd937 HTTP/1.1
Host: ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2025 12:00:00 GMT
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
x-kss-request-id: 56594298207FB3044385****
Date: Wed, 01 Mar 2025 12:00:00 GMT
Content-Type: application/xml
Content-Length: length
Connection: keep-alive
Server: ks3

<ListJobsResult>
    <Jobs>
        <Member>
            <CreationTime>2025-04-16T16:04:52Z</CreationTime>
            <Description>myjob1</Description>
            <JobId>184ce261-18af-5e3d-3e30-253723cfd937</JobId>
            <Operation>KS3DeleteObject</Operation>
            <Priority>1</Priority>
            <ProgressSummary>
                <NumberOfTasksFailed>0</NumberOfTasksFailed>
                <NumberOfTasksSucceeded>1000</NumberOfTasksSucceeded>
                <TotalNumberOfTasks>1000</TotalNumberOfTasks>
            </ProgressSummary>
            <Status>Complete</Status>
            <TerminationDate>2025-04-16T17:04:52Z</TerminationDate>
        </Member>
        <Member>
            <CreationTime>2025-04-17T16:04:52Z</CreationTime>
            <Description>myjob2</Description>
            <JobId>184ce261-18af-5e3d-3e30-253723cfd938</JobId>
            <Operation>KS3RestoreObject</Operation>
            <Priority>2</Priority>
            <ProgressSummary>
                <NumberOfTasksFailed>0</NumberOfTasksFailed>
                <NumberOfTasksSucceeded>2000</NumberOfTasksSucceeded>
                <TotalNumberOfTasks>2000</TotalNumberOfTasks>
            </ProgressSummary>
            <Status>Complete</Status>
            <TerminationDate>2025-04-17T17:04:52Z</TerminationDate>
        </Member>
    </Jobs>
    <NextToken></NextToken>
</ListJobsResult>

错误码

状态码（Status）

错误码（Code）

描述

400 Bad Request

InvalidArgument

输入的参数无效或不合法。

400 Bad Request

InvalidRequest

请求不合法。

文档导读
上一篇：DescribeJob
下一篇：UpdateJobPriority
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈