You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
文档预览
CreateDocProcessJobs
复制全文
下载 pdf
CreateDocProcessJobs
功能描述​
此接口用于提交文档转码任务。​
注意事项​
  • CreateDocProcessJobs 接口处于邀测状态,如需使用,请联系客户经理。​
  • 源文档支持 doc、docx、ppt、pptx、xls、xlsx、pdf 格式。​
  • 支持文档转码为 jpg、png、pdf 格式,不支持转码为 html 格式。​
  • 存储结果的目标桶需和源桶在同一 Region 和同一租户下。​
请求消息样式​
​
POST /?doc_jobs&job_type=DocConvert HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
Content-Type: application/json​
​
{​
"Input" : {​
"Key":"input/obj1.docx"​
},​
"DocProcessConfig" : {​
"TgtType": "jpg",​
"StartPage" : 1,​
"EndPage" : 2​
},​
"Output" : {​
"Region" : "cn-beijing",​
"Bucket" : "testbkt",​
"Object" : "async/test-${Page}.jpg"​
}​
}​
​
请求参数和消息头​
该请求使用的公共请求消息头,请参见公共参数。​
​
名称​
位置​
参数类型​
是否必选​
示例值​
说明​
doc_jobs​
Query​
String​
是​
-​
代表提交文档转码任务请求的特殊标识。​
job_type​
Query​
String​
是​
DocConvert​
任务类型,文档转码场景下取值仅为 DocConvert。​
​
请求元素​
​
名称​
参数类型​
是否必选​
示例值​
说明​
Input​
Obiect​
是​
-​
待操作的文件信息。​
Key​
String​
是​
input/obj1.docx​
存储桶中的包含路径的完整文件名称。​
父节点:Input​
DocProcessConfig​
Obiect​
是​
-​
文档转码的具体配置。​
StartPage​
Integer​
是​
1​
从第 X 页开始转换。​
在表格文件中,一张表可能分割为多页转换,生成多张图片,最小值为 1​
父节点:DocProcessConfig​
EndPage​
Integer​
是​
2​
转换至第 X 页。​
在表格文件中,一张表可能分割为多页转换,生成多张图片,最小值为 -1 代表转换全部页。​
父节点:DocProcessConfig​
SrcType​
String​
否​
-​
源数据的后缀类型。​
如果设置源类型优先按照设置后的值来处理,没设置的话,按照指定对象的后缀名来确定源数据类型。当指定的对象没有后缀名时,可以设置该值。​
父节点:DocProcessConfig​
TgtType​
String​
否​
jpg​
转换输出目标文件类型。​
  • jpg:转成 jpg 格式的图片文件;如果传入的格式未能识别,默认使用 jpg 格式。​
  • png:转成 png 格式的图片文件。​
  • pdf:转成 pdf 格式文件(暂不支持指定页数范围和表格 SheetId)。​
父节点:DocProcessConfig​
Output​
Obiect​
是​
-​
指定转码后处理结果保存的地址信息。​
Region​
String​
是​
cn-beijing​
存储桶的地域。​
父节点:Output​
Bucket​
String​
是​
testbkt​
存储结果的存储桶。​
父节点:Output​
Object​
String​
是​
abc_${Page}.jpg​
输出文件路径。​
  • 输出文件名需包含 ${Page} 参数。多个输出文件,${Page} 表示序号与预览页码一致。​
  • ${Page} 表示多个输出文件,序号与预览页码一致,例如输入 abc_${Page}.jpg,预览某文件 5-6 页,则输出文件名为 abc_5.jpg,abc_6.jpg。​
父节点:Output​
​
响应消息头​
该请求返回的公共响应消息头,请参见公共参数。​
响应元素​
​
名称​
参数类型​
示例值​
说明​
Code​
String​
OK​
错误码。​
错误码是唯一标识错误条件的字符串。​
Message​
String​
Success​
错误响应消息中对具体错误的详细英文描述。​
只有任务失败时才会返回。​
JobId​
String​
1878c5dd2*****67f6fff7​
新创建任务的 ID。​
​
请求示例​
​
POST /?doc_jobs&job_type=DocConvert HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
Content-Type: application/json​
​
{​
"Input" : {​
"Key":"input/obj1.docx"​
},​
"DocProcessConfig" : {​
"TgtType": "jpg",​
"StartPage" : 1,​
"EndPage" : 2​
},​
"Output" : {​
"Region" : "cn-beijing",​
"Bucket" : "testbkt",​
"Object" : "async/test-{Page}.jpg"​
}​
}​
​
响应示例​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
​
{​
"Code" : "OK",​
"Message" : "Success",​
"JobId": "1878c5dd2*****67f6fff7"​
}​
​
​
最近更新时间:2026.10.21 16:29:35
这个页面对您有帮助吗?
有用
有用
无用
无用