动态与公告

产品动态

产品公告

产品简介

产品概述

功能概览

应用场景

产品优势

基本概念

地域和访问域名

规格与限制

产品计费

计费概述

计费方式

计费项

免费额度

计费示例

查看和下载账单

欠费说明

常见问题

快速入门

控制台快速入门

COSBrowser 快速入门

用户指南

创建请求

存储桶

对象

数据管理

批量处理

全球加速

监控与告警

运维中心

数据处理

内容审核

智能工具箱

数据工作流

应用集成

工具指南

工具概览

环境安装与配置

COSBrowser 工具

COSCLI 工具

COSCMD 工具

COS Migration 工具

FTP Server 工具

Hadoop 工具

COSDistCp 工具

HDFS TO COS 工具

GooseFS-Lite 工具

在线辅助工具

自助诊断工具

实践教程

概览

访问控制与权限管理

性能优化

使用 AWS S3 SDK 访问 COS

数据容灾备份

域名管理实践

图片处理实践

COS 音视频播放器实践

工作流实践

数据直传

内容审核实践

数据安全

数据校验

大数据实践

COS 成本优化解决方案

在第三方应用中使用 COS

迁移指南

本地数据迁移至 COS

第三方云存储数据迁移至 COS

以 URL 作为源地址的数据迁移至 COS

COS 之间数据迁移

Hadoop 文件系统与 COS 之间的数据迁移

数据湖存储

云原生数据湖

元数据加速

数据加速器 GooseFS

数据处理

数据处理概述

图片处理

媒体处理

内容审核

文件处理

文档处理

故障处理

获取 RequestId 操作指引

通过外网上传文件至 COS 缓慢

访问 COS 时返回403错误码

资源访问异常

POST Object 常见异常

API 文档

简介

公共请求头部

公共响应头部

错误码

请求签名

操作列表

Service 接口

Bucket 接口

Object 接口

批量处理接口

数据处理接口

任务与工作流

内容审核接口

云查毒接口

SDK 文档

SDK 概览

准备工作

Android SDK

C SDK

C++ SDK

.NET(C#) SDK

Flutter SDK

Go SDK

iOS SDK

Java SDK

JavaScript SDK

Node.js SDK

PHP SDK

Python SDK

React Native SDK

小程序 SDK

错误码

鸿蒙(Harmony) SDK

终端 SDK 质量优化

安全与合规

数据容灾

数据安全

访问管理

常见问题

热门问题

一般性问题

计费计量问题

域名合规问题

存储桶配置问题

域名和 CDN 问题

文件操作问题

日志监控问题

权限管理问题

数据处理问题

数据安全问题

预签名 URL 问题

SDK 类问题

工具类问题

API 类问题

服务协议

Service Level Agreement

隐私政策

数据处理和安全协议

联系我们

词汇表

ListJobs

PDF

聚焦模式

字号

最后更新时间： 2023-12-21 17:43:49

功能描述
ListJobs 用于列出您的批量处理任务。有关批量处理任务的详细介绍，可参见 批量处理概述。
请求
请求示例
GET /jobs?jobStatuses=<JobStatuses>&maxResults=<MaxResults>&nextToken=<NextToken> HTTP/1.1
x-cos-appid: <appid>
请求参数
调用 ListJobs 所需要使用的参数。该参数格式如下：
参数
描述
是否必选
jobStatuses
您所需查询的任务状态信息。如您未指定任务状态，则 COS 将返回所有执行过的任务状态，包括正在执行的任务。若您指定任务状态，则 COS 将返回指定状态的任务。可选的任务状态包括：Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended。
否
maxResults
COS 返回的任务数量最大值。如您配置了此项参数，每次返回的任务数最多不会超过这个最大值。您可以配合 nextToken 参数进行分页返回。该参数范围为1 - 1000，默认为1000。
否
nextToken
翻页符。每次 list 操作会返回本次任务列表的最后一个 JobId 作为 nextToken，在下一次 list 传入该值，即可接续上一次 list 的内容进行 list，用于分页。该参数的长度限制在1 - 64字节。
否
x-cos-appid
用户的 APPID，长度为1 - 64字节。
是
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
该请求无请求体。
响应
响应示例
HTTP/1.1 200
<ListJobsResult>
...
</ListJobsResult>
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
<ListJobsResult>
    <Jobs>
        <member>
            <CreationTime>timestamp</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>timestamp</TerminationDate>
        </member>
    </Jobs>
    <NextToken></NextToken>
</ListJobsResult>
具体内容描述如下：
ListJobsResult
包含COS返回的批量处理任务列表信息。
节点名
父节点
描述
类型
Jobs
ListJobsResult
包含 COS 返回的多个批量处理任务信息。
Jobs Object
NextToken
ListJobsResult
每次ListJobs操作会返回本次任务列表的最后一个 JobId 作为 nextToken，在下一次 ListJobs 传入该值，返回结果即可接续上一次 ListJobs 的内容，用于分页。该参数的长度限制在1 - 64字节。
String
Jobs
节点名
父节点
描述
类型
member
Jobs
包含 COS 返回的某个批量处理任务信息。
member Object
member
节点名
父节点
描述
类型
CreationTime
member
任务创建时间。
Timestamp
Description
member
任务描述。长度限制为0 - 256字节。
String
JobId
member
任务 ID。长度限制为1 - 64字节。
String
Operation
member
批量处理任务中对对象执行的操作。例如 COSPutObjectCopy
String
Priority
member
任务优先级。值越大的任务将会被优先执行。优先级大小限制为0 - 2147483647。
Integer
ProgressSummary
member
任务执行状况概述。描述您此项任务中所执行的操作总数，成功的操作数量以及失败的操作数量。
ProgressSummary Object
Status
member
任务执行状态。合法参数值包括 Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended。
String
TerminationDate
member
批量处理任务的结束时间。
Timestamp
其他元素请参见 批量处理功能公共元素。
错误分析
该请求可能会发生的一些常见的特殊错误如下：
错误代码
描述
状态码
API
InvalidArgument
Parameter jobStatuses is invalid
400
ListJobs
InvalidArgument
maxResults 参数必须为整数
400
ListJobs
InvalidArgument
nextToken 参数无效
400
ListJobs
其他错误请参考 批量处理功能错误响应。

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

对象存储

ListJobs

功能描述

请求

响应

错误分析

帮助和支持

参数	描述	是否必选
jobStatuses	您所需查询的任务状态信息。如您未指定任务状态，则 COS 将返回所有执行过的任务状态，包括正在执行的任务。若您指定任务状态，则 COS 将返回指定状态的任务。可选的任务状态包括：Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended。	否
maxResults	COS 返回的任务数量最大值。如您配置了此项参数，每次返回的任务数最多不会超过这个最大值。您可以配合 nextToken 参数进行分页返回。该参数范围为1 - 1000，默认为1000。	否
nextToken	翻页符。每次 list 操作会返回本次任务列表的最后一个 JobId 作为 nextToken，在下一次 list 传入该值，即可接续上一次 list 的内容进行 list，用于分页。该参数的长度限制在1 - 64字节。	否
x-cos-appid	用户的 APPID，长度为1 - 64字节。	是

节点名	父节点	描述	类型
Jobs	ListJobsResult	包含 COS 返回的多个批量处理任务信息。	Jobs Object
NextToken	ListJobsResult	每次ListJobs操作会返回本次任务列表的最后一个 JobId 作为 nextToken，在下一次 ListJobs 传入该值，返回结果即可接续上一次 ListJobs 的内容，用于分页。该参数的长度限制在1 - 64字节。	String

错误代码	描述	状态码	API
InvalidArgument	Parameter jobStatuses is invalid	400	ListJobs
InvalidArgument	maxResults 参数必须为整数	400	ListJobs
InvalidArgument	nextToken 参数无效	400	ListJobs