History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
POST /doc_jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
<Request><Tag></Tag><Input><Object></Object></Input><Operation><Output><Region></Region><Bucket></Bucket><Object></Object></Output><DocProcess><StartPage></StartPage><EndPage></EndPage><TgtType></TgtType></DocProcess></Operation><QueueId></QueueId></Request>
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件在 COS 上的文件路径，Bucket 由 Host 指定 | String | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
DocProcess | Request.Operation | 当 Tag 为 DocProcess 时有效，指定该任务的参数 | Container | 是 |
Output | Request.Operation | 结果输出地址 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
SrcType | Request.Operation.DocProcess | 源数据的后缀类型，当前文档转换根据 cos 对象的后缀名来确定源数据类型，当 cos 对象没有后缀名时，可以设置该值 | String | 否 |
TgtType | Request.Operation.DocProcess | 转换输出目标文件类型： jpg，转成 jpg 格式的图片文件；如果传入的格式未能识别，默认使用 jpg 格式 png，转成 png 格式的图片文件 pdf，转成 pdf 格式文件（暂不支持指定页数） | String | 否 |
StartPage | Request.Operation.DocProcess | 从第 X 页开始转换；在表格文件中，一张表可能分割为多页转换，生成多张图片。StartPage 表示从指定 SheetId 的第 X 页开始转换。默认为1 | Int | 否 |
EndPage | Request.Operation.DocProcess | 转换至第 X 页；在表格文件中，一张表可能分割为多页转换，生成多张图片。EndPage 表示转换至指定 SheetId 的第 X 页。默认为-1，即转换全部页 | Int | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
SheetId | Request.Operation.DocProcess | 表格文件参数，转换第 X 个表，默认为0；设置 SheetId 为0，即转换文档中全部表 | Int | 否 |
PaperDirection | Request.Operation.DocProcess | 表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0 | Int | 否 |
PaperSize | Request.Operation.DocProcess | 设置纸张（画布）大小，对应信息为： 0 → A4 、 1 → A2 、 2 → A0 ，默认 A4 纸张 | Int | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
ImageParams | Request.Operation.DocProcess | String | 否 | |
Quality | Request.Operation.DocProces | 生成预览图的图片质量，取值范围 [1-100]，默认值100。 例：值为100，代表生成图片质量为100% | Int | 否 |
Zoom | Request.Operation.DocProces | 预览图片的缩放参数，取值范围[10-200]， 默认值100。 例：值为200，代表图片缩放比例为200% 即放大两倍 | Int | 否 |
ImageDpi | Request.Operation.DocProcess | 按指定 dpi 渲染图片，该参数与 Zoom 共同作用，取值范围 96-600 ，默认值为 96 。转码后的图片单边宽度需小于65500像素 | Int | 否 |
PicPagination | Request.Operation.DocProcess | 是否转换成单张长图，设置为 1 时，最多仅支持将 20 标准页面合成单张长图，超过可能会报错，分页范围可以通过 StartPage、EndPage 控制。默认值为 0 ，按页导出图片，TgtType="png"/"jpg" 时生效 | Int | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 输出文件路径。 非表格文件输出文件名需包含 ${Number} 或 ${Page} 参数。多个输出文件，${Number} 表示序号从1开始，${Page} 表示序号与预览页码一致。 ${Number} 表示多个输出文件，序号从1开始，例如输入 abc_${Number}.jpg，预览某文件5 - 6页，则输出文件名为 abc_1.jpg，abc_2.jpg ${Page} 表示多个输出文件，序号与预览页码一致，例如输入 abc_${Page}.jpg，预览某文件5-6页，则输出文件名为 abc_5.jpg，abc_6.jpg 表格文件输出路径需包含 ${SheetID} 占位符，输出文件名必须包含 ${Number} 参数。 例如 /${SheetID}/abc_${Number}.jpg，先根据 excel 转换的表格数，生成对应数量的文件夹，再在对应的文件夹下，生成对应数量的图片文件 | String | 是 |
<Response><JobsDetail><Code></Code><CreationTime></CreationTime><EndTime></EndTime><Input><Object></Object></Input><JobId></JobId><Message/><Operation><DocProcess><SrcType></SrcType><TgtType></TgtType><StartPage></StartPage><EndPage></EndPage><ImageParams></ImageParams></DocProcess><Output><Bucket></Bucket><Object></Object><Region></Region></Output></Operation><QueueId></QueueId><State></State><Tag></Tag></JobsDetail></Response>
节点名称（关键字） | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码，只有 State 为 Failed 时有意义 | String |
Message | Response.JobsDetail | 错误描述，只有 State 为 Failed 时有意义 | String |
JobId | Response.JobsDetail | 新创建任务的 ID | String |
Tag | Response.JobsDetail | 新创建任务的 Tag：DocProcess | String |
State | Response.JobsDetail | 任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
QueueId | Response.JobsDetail | 任务所属的队列 ID | String |
Input | Response.JobsDetail | 该任务的输入文件路径 | Container |
Operation | Response.JobsDetail | 该任务的规则 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
DocProcess | Response.JobsDetail.Operation | 文档预览任务参数 | Container |
Output | Response.JobsDetail.Operation | 文件的输出地址 | Container |
POST /doc_jobs HTTP/1.1Connection: keep-aliveAccept-Encoding: gzip, deflateAccept: */*User-Agent: cos-python-sdk-v5.3.2Host: examplebucket-1250000000.ci.ap-chongqing.myqcloud.comContent-Type: application/xmlContent-Length: 546Authorization: Authorization<?xml version="1.0" encoding="UTF-8" ?><Request><Input><Object>1.doc</Object></Input><Operation><Output><Region>ap-chongqing</Region><Object>big/test-${Number}</Object><Bucket>examplebucket-1250000000</Bucket></Output><DocProcess><TgtType>png</TgtType><StartPage>1</StartPage><EndPage>-1</EndPage><ImageParams>watermark/1/image/aHR0cDovL3Rlc3QwMDUtMTI1MTcwNDcwOC5jb3MuYXAtY2hvbmdxaW5nLm15cWNsb3VkLmNvbS8xLmpwZw==/gravity/southeast</ImageParams></DocProcess></Operation><Tag>DocProcess</Tag><QueueId>p532fdead78444e649e1a4467c1cd19d3</QueueId></Request>[!http]
HTTP/1.1 200 OKDate: Mon, 27 Jul 2020 07:20:08 GMTContent-Type: application/xmlContent-Length: 863Connection: keep-aliveServer: tencent-cix-ci-request-id: NWYxZTgwMjhfYzc2OTQzNjRfMzUx****<?xml version="1.0" encoding="utf-8"?><Response><JobsDetail><Code>Success</Code><CreationTime>2020-07-27T15:20:08+0800</CreationTime><EndTime>-</EndTime><Input><Object>1.doc</Object></Input><JobId>d99b3127ecfd911eab5e60dedb7c395dd</JobId><Message/><Operation><DocProcess><EndPage>5001</EndPage><ImageParams>watermark/1/image/aHR0cDovL3Rlc3QwMDUtMTI1MTcwNDcwOC5jb3MuYXAtY2hvbmdxaW5nLm15cWNsb3VkLmNvbS8xLmpwZw==/gravity/southeast</ImageParams><SrcType/><StartPage>1</StartPage><TgtType>png</TgtType></DocProcess><Output><Bucket>examplebucket-1250000000</Bucket><Object>big/test-${Number}</Object><Region>ap-chongqing</Region></Output></Operation><QueueId>p532fdead78444e649e1a4467c1cd19d3</QueueId><State>Submitted</State><Tag>DocProcess</Tag></JobsDetail></Response>
文档反馈