- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Developer Manual
- API Documentation
- Bucket Configuration
- Image Processing
- Basic Image Processing
- Scaling
- Cropping
- Rotating
- Converting Format
- Quality Change
- Gaussian Blurring
- Adjusting Brightness
- Adjusting Contrast
- Sharpening
- Image Watermarking
- Text Watermarking
- Obtaining Basic Image Information
- Obtaining Image EXIF
- Obtaining Image’s Average Hue
- Removing Image Metadata
- Quick Thumbnail Template
- Pipeline Operators
- Limiting Output Image Size
- Supported Fonts
- Image Styles
- Image Compression
- Blind Watermarking
- Persistent Image Processing
- Basic Image Processing
- AI-Based Content Recognition
- Media Processing
- Common Request Headers
- Common Response Headers
- Error Codes
- Template APIs
- Media Bucket APIs
- Queue APIs
- Job APIs
- Animated Image Job APIs
- Screenshot Job APIs
- Transcoding Job APIs
- Intelligent Thumbnail Job APIs
- Splicing Job APIs
- Multi-Job APIs
- Video Montage Job APIs
- Voice/Sound Separation Job APIs
- Video Enhancement Job APIs
- SDR-to-HDR Job APIs
- Super Resolution Job APIs
- Audio/Video Segmentation Job APIs
- Media Information Query Job
- Media Screenshot API
- Media Information API
- Workflow APIs
- Private M3U8 API
- Callback Content
- Error Codes
- SDK Documentation
- Android SDK
- C SDK
- C++ SDK
- .NET(C#) SDK
- Go SDK
- iOS SDK
- Java SDK
- JavaScript SDK
- Node.js SDK
- PHP SDK
- Media Processing
- Job APIs
- Animated Image Job APIs
- Screenshot Job APIs
- Transcoding Job APIs
- Splicing Job APIs
- Intelligent Thumbnail Job APIs
- Multi-Job APIs
- Video Enhancement Job APIs
- Video Montage Job APIs
- Voice/Sound Separation Job APIs
- SDR-to-HDR Job APIs
- Digital Watermark Job APIs
- Super Resolution Job APIs
- Video Tagging Job APIs
- Remuxing Job APIs
- Python SDK
- Mini Program SDK
- FAQs
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Developer Manual
- API Documentation
- Bucket Configuration
- Image Processing
- Basic Image Processing
- Scaling
- Cropping
- Rotating
- Converting Format
- Quality Change
- Gaussian Blurring
- Adjusting Brightness
- Adjusting Contrast
- Sharpening
- Image Watermarking
- Text Watermarking
- Obtaining Basic Image Information
- Obtaining Image EXIF
- Obtaining Image’s Average Hue
- Removing Image Metadata
- Quick Thumbnail Template
- Pipeline Operators
- Limiting Output Image Size
- Supported Fonts
- Image Styles
- Image Compression
- Blind Watermarking
- Persistent Image Processing
- Basic Image Processing
- AI-Based Content Recognition
- Media Processing
- Common Request Headers
- Common Response Headers
- Error Codes
- Template APIs
- Media Bucket APIs
- Queue APIs
- Job APIs
- Animated Image Job APIs
- Screenshot Job APIs
- Transcoding Job APIs
- Intelligent Thumbnail Job APIs
- Splicing Job APIs
- Multi-Job APIs
- Video Montage Job APIs
- Voice/Sound Separation Job APIs
- Video Enhancement Job APIs
- SDR-to-HDR Job APIs
- Super Resolution Job APIs
- Audio/Video Segmentation Job APIs
- Media Information Query Job
- Media Screenshot API
- Media Information API
- Workflow APIs
- Private M3U8 API
- Callback Content
- Error Codes
- SDK Documentation
- Android SDK
- C SDK
- C++ SDK
- .NET(C#) SDK
- Go SDK
- iOS SDK
- Java SDK
- JavaScript SDK
- Node.js SDK
- PHP SDK
- Media Processing
- Job APIs
- Animated Image Job APIs
- Screenshot Job APIs
- Transcoding Job APIs
- Splicing Job APIs
- Intelligent Thumbnail Job APIs
- Multi-Job APIs
- Video Enhancement Job APIs
- Video Montage Job APIs
- Voice/Sound Separation Job APIs
- SDR-to-HDR Job APIs
- Digital Watermark Job APIs
- Super Resolution Job APIs
- Video Tagging Job APIs
- Remuxing Job APIs
- Python SDK
- Mini Program SDK
- FAQs
- Contact Us
Overview
This API (Trigger Workflow) is used to manually trigger a workflow.
Request
Sample request
POST /triggerworkflow?workflowId=xxx&object=xxx HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
Note：Authorization: Auth String (for more information, see Request Signature).
Request parameters
| Field | Description | Type | Required |
|---|---|---|---|
| workflowId | ID of the workflow to trigger | String | Yes |
| object | Name of the object that requires workflow processing | String | Yes |
| name | Name of the existing triggered task, which can contain up to 128 letters, digits, hyphens, and underscores and is empty by default | String | No |
Request headers
This API only uses common request headers. For more information, see Common Request Headers.
Request body
The request body of this request is empty.
Response
Response headers
This API only returns common response headers. For more information, see Common Response Headers.
Response body
The response body returns application/xml data. The following contains all the nodes:
<Response>
<RequestId>NjA0MWExNGVfOTBmYTUwNjRfMzc0M****</RequestId>
<InstanceId>i6fc78ca77d6011eba0ac5254008618d9=</InstanceId>
<Response>
The nodes are described as follows:
| Node Name (Keyword) | Parent Node | Description | Type |
|---|---|---|---|
| Response | None | Response container | Container |
Response has the following sub-nodes:
| Node Name (Keyword) | Parent Node | Description | Type |
|---|---|---|---|
| RequestId | Response | Unique ID of the request | String |
| InstanceId | Response | Instance ID | String |
Error codes
There are no special error messages for this request. For common error messages, see Error Codes.
Use Cases
Request
POST /triggerworkflow/?workflowId=xxx&object=xxx HTTP/1.1
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
Content-Length: 0
Content-Type: application/xml
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<RequestId>NjA0MWExNGVfOTBmYTUwNjRfMzc0M****</RequestId>
<InstanceId>i6fc78ca77d6011eba0ac5254008618d9=</InstanceId>
<Response>
Yes
No
Was this page helpful?