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

Torch Object Storage

Copy page
Download PDF
Workflow
GetWorkflow
Copy page
Download PDF
GetWorkflow
Description​
This API retrieves workflow configuration information.​
Notes​
None.​
Request syntax​
​
GET /?workflow HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization string​
​
Request parameters and headers ​
​
Field name​
Location​
Type​
Required​
Example value​
Description​
workflow​
Query​
String​
Yes​
-​
Special identifier representing the GetWorkflow request.​
​
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​
Rules​
Content​
-​
Workflow configuration information.​
ID​
String​
my-wf-rule-1​
Name of the workflow.​
Parent node: Rules​
Enabled​
String​
true​
Enable this workflow. The value explanations are as follows:​
  • true: Enable the workflow; after uploading the object to the specified path, the workflow will execute automatically.​
  • false: Stop the workflow.​
Parent node: Rules​
Prefix​
String​
my-audio-dir/​
Path bound to the workflow.​
The workflow triggers only when files upload to this path. If not specified, the binding applies to the entire bucket, triggering the workflow whenever files upload to the bucket.​
Parent node: Rules​
ExtFilter​
Content​
-​
Media type.​
Parent node: Rules​
AudioExts​
String​
wav​
Media type.​
Only media of this type can trigger the workflow; currently, only the value wav is supported.​
Parent node: ExtFilter​
Topology​
String​
my-op-1​
Template names included in the workflow.​
Operations​
Content​
-​
Template information.​
Parent node: Rules​
AudioTranscode​
Content​
-​
Audio transcoding template information.​
Parent node: Operations​
OperationID​
String​
my-op-1​
Workflow template name.​
Parent node: AudioTranscode​
Format​
String​
mp3​
Transcoding output format currently only supports the value mp3.​
Parent node: AudioTranscode​
Bitrate​
Number​
128000​
Transcoding bitrate, currently only supports the value 128000.​
Parent node: AudioTranscode​
Output​
Content​
-​
File storage location.​
Parent node: AudioTranscode​
Region​
String​
cn-beijing​
Region where the transcoded audio files are stored.​
Parent node: Output​
Bucket​
String​
my-bucket​
Bucket for storing transcoded audio files.​
Parent node: Output​
Object​
String​
test.mp3​
Name of the transcoded audio file.​
Parent node: Output​
​
Sample request​
​
GET /?workflow HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization string​
​
Sample response​
​
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​
Content-Length: 643​
​
{​
"Rules": [​
{​
"ID": "my-wf-rule-1",​
"Status": "Enabled",​
"Prefix": "my-audio-dir/",​
"ExtFilter": {​
"AudioExts": [ "wav" ]​
},​
"Topology": [​
[ "my-op-1" ]​
],​
"Operations": {​
"AudioTranscode": [​
{​
"OperationID": "my-op-1",​
"Format": "mp3",​
"Bitrate": 128000,​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "my-bucket",​
"Object": "${InputPath}/${InputName}-${RunID}.mp3"​
}​
}​
]​
}​
}​
]​
}​
​
​
Last updated: 2025.12.03 16:14:57