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
隐私政策
数据处理和安全协议
联系我们
词汇表

查询指定的文档转码任务

PDF
聚焦模式
字号
最后更新时间: 2026-01-13 15:12:50

功能描述

DescribeDocProcessJob 用于查询指定的文档转码任务。

请求

注意:
文档预览任务记录保留一个月,请及时保存任务记录。建议配置回调进行任务结果查询。

请求示例

GET /doc_jobs/<jobId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
说明:
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求无请求体。

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<JobsDetail>
<Code></Code>
<CreationTime></CreationTime>
<EndTime></EndTime>
<Input>
<Object></Object>
</Input>
<JobId></JobId>
<Message> </Message>
<Operation>
<DocProcess>
<EndPage></EndPage>
<ImageParams></ImageParams>
<SrcType></SrcType>
<StartPage></StartPage>
<TgtType></TgtType>
</DocProcess>
<DocProcessResult>
<FailPageCount></FailPageCount>
<PageInfo>
<PageNo></PageNo>
<TgtUri></TgtUri>
</PageInfo>
<SuccPageCount></SuccPageCount>
<TaskId></TaskId>
<TgtType></TgtType/>
<TotalPageCount></TotalPageCount>
</DocProcessResult>
<Output>
<Bucket></Bucket>
<Object></Object>
<Region></Region>
</Output>
</Operation>
<QueueId></QueueId>
<State></State>
<Tag></Tag>
</JobsDetail>
</Response>
具体的数据内容如下:
节点名称(关键字)
父节点
描述
类型
Response
保存结果的容器
Container
Container 节点 Response 的内容:
节点名称(关键字)
父节点
描述
类型
JobsDetail
Response
任务的详细信息,同 CreateDocProcessJobs 接口的 Response.JobsDetail 节点
Container
NonExistJobIds
Response
查询的 ID 中不存在的任务,所有任务都存在时不返回
String
Container 节点 Operation 的内容:
节点名称(关键字)
父节点
描述
类型
DocProcess
Response.JobsDetail.Operation
文档预览任务参数,同 CreateDocProcessJobs 接口的 Request.Operation.DocProcess 节点
Container
DocProcessResult
Response.JobsDetail.Operation
在 job 的类型为 DocProcess 且 job 状态为 success 时,返回文档预览任务结果详情
Container
Output
Response.JobsDetail.Operation
结果输出地址,同 CreateDocProcessJobs 接口的 Request.Operation.Output 节点
Container
Container 节点 DocProcessResult 节点的内容
节点名称(关键字)
父节点
描述
类型
PageInfo
Response.JobsDetail.Operation.DocProcessResult
预览任务产物详情
Container
TgtType
Response.JobsDetail.Operation.DocProcessResult
预览产物目标格式
String
TotalPageCount
Response.JobsDetail.Operation.DocProcessResult
预览任务产物的总数
Int
SuccPageCount
Response.JobsDetail.Operation.DocProcessResult
预览任务产物的成功数
Int
FailPageCount
Response.JobsDetail.Operation.DocProcessResult
预览任务产物的失败数
Int
TotalSheetCount
Response.JobsDetail.Operation.DocProcessResult
预览任务的 Sheet 总数(源文件为 Excel 特有参数)
Int
Container 节点 PageInfo 节点的内容
节点名称(关键字)
父节点
描述
类型
PageNo
Response.JobsDetail.Operation.DocProcessResult.PageInfo
预览产物页码,源文件为 Excel 格式时表示 SheetId
Container
TgtUri
Response.JobsDetail.Operation.DocProcessResult.PageInfo
预览产物生成的 cos 桶路径
Int
X-SheetPics
Response.JobsDetail.Operation.DocProcessResult.PageInfo
当前 Sheet 生成的图片总数(源文件为 Excel 特有参数)
Int
PicIndex
Response.JobsDetail.Operation.DocProcessResult.PageInfo
当前预览产物在整个源文件中的序号(源文件为 Excel 特有参数)
Int
PicNum
Response.JobsDetail.Operation.DocProcessResult.PageInfo
当前预览产物在 Sheet 中的序号(源文件为 Excel 特有参数)
Int

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

GET /doc_jobs/d13cfd584cd9011ea820b597ad1785a2f HTTP/1.1
Accept: */*
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com

1.非 Excel 文档请求响应

<Response>
<JobsDetail>
<Code>Success</Code>
<CreationTime>2020-07-24T17:28:47+0800</CreationTime>
<EndTime>2020-07-24T17:28:49+0800</EndTime>
<Input>
<Object>1.doc</Object>
</Input>
<JobId>d13cfd584cd9011ea820b597ad1785a2f</JobId>
<Message/>
<Operation>
<DocProcess>
<EndPage>0</EndPage>
<ImageParams/>
<SrcType/>
<StartPage>2</StartPage>
<TgtType>png</TgtType>
</DocProcess>
<DocProcessResult>
<FailPageCount>0</FailPageCount>
<PageInfo>
<PageNo>2</PageNo>
<TgtUri>big/test-1</TgtUri>
</PageInfo>
<SuccPageCount>1</SuccPageCount>
<TaskId/>
<TgtType/>
<TotalPageCount>2</TotalPageCount>
</DocProcessResult>
<Output>
<Bucket>examplebucket-1250000000</Bucket>
<Object>big/test-${Number}</Object>
<Region>ap-chongqing</Region>
</Output>
</Operation>
<QueueId>p50882922b848464fadd222d771438328</QueueId>
<State>Success</State>
<Tag>DocProcess</Tag>
</JobsDetail>
</Response>

2. Excel 格式响应

<Response>
<JobsDetail>
<Code>Success</Code>
<CreationTime>2020-12-03T19:54:10+0800</CreationTime>
<EndTime>2020-12-03T19:54:13+0800</EndTime>
<Input>
<Object>1.xlsx</Object>
</Input>
<JobId>d13cfd584cd9011ea820b597ad1785a2f</JobId>
<Message/>
<Operation>
<DocProcess>
<Comments>0</Comments>
<DocPassword/>
<EndPage>2</EndPage>
<ImageParams/>
<PaperDirection>0</PaperDirection>
<PaperSize>0</PaperSize>
<Quality>100</Quality>
<SheetId>0</SheetId>
<SrcType/>
<StartPage>1</StartPage>
<TgtType/>
<Zoom>100</Zoom>
</DocProcess>
<DocProcessResult>
<FailPageCount>0</FailPageCount>
<PageInfo>
<PageNo>1</PageNo>
<PicIndex>1</PicIndex>
<PicNum>1</PicNum>
<TgtUri>mark2/1/test-1.jpg</TgtUri>
<X-SheetPics>2</X-SheetPics>
</PageInfo>
<PageInfo>
<PageNo>1</PageNo>
<PicIndex>2</PicIndex>
<PicNum>2</PicNum>
<TgtUri>mark2/1/test-2.jpg</TgtUri>
<X-SheetPics>2</X-SheetPics>
</PageInfo>
<SuccPageCount>6</SuccPageCount>
<TaskId/>
<TgtType/>
<TotalPageCount>6</TotalPageCount>
<TotalSheetCount>3</TotalSheetCount>
</DocProcessResult>
<Output>
<Bucket>markjrzhang-1251704708</Bucket>
<Object>mark/${SheetID}/pic-${Page}.jpg</Object>
<Region>ap-chongqing</Region>
</Output>
</Operation>
<QueueId>p5fdbba9a9b83479f84538d5beb*****</QueueId>
<State>Success</State>
<Tag>DocProcess</Tag>
</JobsDetail>
</Response>


帮助和支持

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

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

文档反馈