tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
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
隐私政策
数据处理和安全协议
联系我们
词汇表

DescribeJob

PDF
聚焦模式
字号
最后更新时间: 2023-12-21 17:43:22

功能描述

DescribeJob 用于获取您配置的批量处理任务的参数和任务执行状态。有关批量处理任务的详细信息,可参见 批量处理概述

请求

请求示例
GET /jobs/<JobId> HTTP/1.1
x-cos-appid: <appid>
请求参数
调用 DescribeJob 所需的参数。该参数格式如下:
参数
描述
是否必选
JobId
任务 ID。
x-cos-appid
用户的 APPID,长度为1 - 64字节。
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求无请求体。

响应

响应示例
HTTP/1.1 200
<DescribeJobResult>
...
</DescribeJobResult>
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
<DescribeJobResult>
<Job>
<ConfirmationRequired>boolean</ConfirmationRequired>
<CreationTime>timestamp</CreationTime>
<Description>string</Description>
<FailureReasons>
<JobFailure>
<FailureCode>string</FailureCode>
<FailureReason>string</FailureReason>
</JobFailure>
</FailureReasons>
<JobId>string</JobId>
<Manifest>
<Location>
<ETag>string</ETag>
<ObjectArn>string</ObjectArn>
</Location>
<Spec>
<Format>string</Format>
</Spec>
</Manifest>
<Operation>
<COSPutObjectCopy>
<CannedAccessControlList>string</CannedAccessControlList>
<MetadataDirective>string</MetadataDirective>
<NewObjectMetadata>
<SSEAlgorithm>string</SSEAlgorithm>
<UserMetadata>
<member>
<Key>string</Key>
<Value>string</Value>
</member>
<member>
<Key>string</Key>
<Value>string</Value>
</member>
</UserMetadata>
</NewObjectMetadata>
<StorageClass>string</StorageClass>
<TargetResource>string</TargetResource>
</COSPutObjectCopy>
</Operation>
<Priority>integer</Priority>
<ProgressSummary>
<NumberOfTasksFailed>integer</NumberOfTasksFailed>
<NumberOfTasksSucceeded>integer</NumberOfTasksSucceeded>
<TotalNumberOfTasks>integer</TotalNumberOfTasks>
</ProgressSummary>
<Report>
<Bucket>string</Bucket>
<Enabled>boolean</Enabled>
<Format>string</Format>
<Prefix>string</Prefix>
<ReportScope>string</ReportScope>
</Report>
<RoleArn>string</RoleArn>
<Status>string</Status>
<StatusUpdateReason>string</StatusUpdateReason>
<SuspendedCause>string</SuspendedCause>
<SuspendedDate>timestamp</SuspendedDate>
<TerminationDate>timestamp</TerminationDate>
</Job>
</DescribeJobResult>
具体内容描述如下:
DescribeJobResult
包含待描述批量处理任务的参数和状态信息。
节点名
父节点
描述
类型
Job
DescribeJobResult
您指定查询的批量处理任务的参数和状态信息。
Job Object
Job
节点名
父节点
描述
类型
ClientRequestToken
Job
每个请求唯一的 token,用于避免前端重复发起同一批处理任务。长度为1 - 64字节,建议使用 UUID。
String
CreationTime
Job
任务创建时间。
Timestamp
Description
Job
任务描述。若您在创建任务时配置了此信息,则会返回该项内容。长度范围为1 - 256字节。
String
FailureReasons
Job
如果任务失败,描述失败的原因。
FailureReasons Object
JobId
Job
创建任务成功后,生成的任务 ID。长度1 - 64字节。
String
Manifest
Job
待处理的对象清单。您需要将需要处理的对象记录在此对象清单内。
Manifest Object
Operation
Job
您需要对清单内的对象批量执行的操作。
Operation Object
Priority
Job
任务优先级。越高的数值代表此项任务的优先级越高。优先级数值范围为0 - 2147483647
Integer
ProgressSummary
Job
任务执行状况概述。描述您此项任务中所执行的操作总数,成功的操作数量以及失败的操作数量。
ProgressSummary Object
Report
Job
指定清单报告的相关配置。
Report Object
RoleArn
Job
您为该任务分配的角色的标识符。长度1 - 1024字节。
String
Status
Job
任务当前状态。合法参数值包括 Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended
String
StatusUpdateReason
Job
状态更新原因。长度为0 - 256字节。
String
SuspendedCause
Job
任务中断的原因。任务仅在您使用控制台创建任务时会进入中断状态,等待您的确认后再进入执行状态。长度为0 - 1024字节。
String
SuspendedDate
Job
任务中断的时间。当任务进入中断状态时,会记录任务中断的时间。
Timestamp
TerminationDate
Job
任务终止的时间。
Timestamp
FailureReasons
节点名
父节点
描述
类型
JobFailure
FailureReasons
任务失败代码和原因。
JobFailure Object
FailureCode
节点名
父节点
描述
类型
FailureCode
JobFailure
任务失败代码。长度0 - 64字节。
String
FailureReason
JobFailure
任务失败原因。长度0 - 256字节。
String
其他元素请参见 批量处理功能公共元素

错误分析

该请求可能会发生的一些常见的特殊错误如下,其他错误请参见 批量处理功能错误响应
错误代码
描述
状态码
API
NoSuchJob
指定任务不存在
404
DescribeJob


帮助和支持

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

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

文档反馈