You need to enable JavaScript to run this app.
Torch Object Storage

Torch Object Storage

Copy page
Download PDF
Document preview
QueryDocProcessJob
Copy page
Download PDF
QueryDocProcessJob
Description​
This interface queries the specified document transcoding asynchronous task.​
Notes​
This interface is currently in invitation-only testing. Contact your account manager to use it.​
Request syntax​
​
Get /?job_type=DocConvert&job_id=1878c5dd2*****67f6fff7 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​
​
​
Request parameters and headers ​
For common request headers, see Common Parameters.​
​
Field name​
Location​
Type​
Required​
Example value​
Description​
job_type​
Query​
String​
Yes​
DocConvert​
The task type, for document transcoding scenarios, only takes the value DocConvert.​
job_id​
Query​
String​
Yes​
1878c5dd2*****67f6fff7​
Document transcoding task ID.​
​
Request body elements​
No elements are used.​
Response headers​
The response contains common headers. For more information, see Common Parameters.​
Response body elements​
​
Field name​
Type​
Example value​
Description​
Code​
String​
0​
Error code.​
that uniquely identifies an error condition.​
State​
String​
Success​
Task status.​
Input​
Array​
-​
Document preview task parameters.​
Same Input as the CreateDocProcessJobs API.​
Operation​
Array​
-​
Specify the processing rules and return results for document transcoding.​
DocProcessConfig​
Array​
-​
Specify the processing rules for document transcoding.​
DocProcessConfig same as the one in the CreateDocProcessJobs interface.​
Parent node: Operation​
Output​
Array​
-​
Result output address.​
Same as the Output in the CreateDocProcessJobs interface.​
Parent node: Operation​
DocProcessResult​
Array​
-​
Result of document transcoding processing.​
Parent node: Operation​
TotalPageCount​
Int​
10​
Total number of pages in the document transcoding task output.​
Parent node: DocProcessResult​
SuccPageCount​
Int​
10​
Number of successful pages produced by the document transcoding task.​
Parent node: DocProcessResult​
FailPageCount​
Int​
0​
Number of failed pages in the document transcoding task output.​
Parent node: DocProcessResult​
​
Sample request​
​
Get /?job_type=DocConvert&job_id=1878c5dd2*****67f6fff7 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​
​
Sample response​
​
HTTP/1.1 200 OK​
Date: Mon, 17 Nov 2025 11:34:47 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
​
{​
"Code": 0,​
"CreateTime": "2025-11-17T19:32:51+08:00",​
"EndTime": "2025-11-17T19:33:24+08:00",​
"Error": "",​
"Input": {​
"Key": "multi_test.ppt"​
},​
"JobID": "1878c8036d74dd3ea1580001e03e3bb473b4",​
"Message": "",​
"Operation": {​
"DocProcessConfig": {​
"EndPage": 10,​
"SrcType": "ppt",​
"StartPage": 1,​
"TgtType": "jpg"​
},​
"DocProcessResult": {​
"FailPageCount": 0,​
"SuccPageCount": 10,​
"TotalPageCount": 10​
},​
"Output": {​
"Bucket": "doc-test-1",​
"Object": "async/multi_test.ppt-{Page}.jpg",​
"Region": "cn-beijing"​
}​
},​
"StartTime": "2025-11-17T19:32:51+08:00",​
"State": "Success"​
}​
​
​
Last updated: 2025.12.03 16:15:24