Triggering Job

Last updated: 2025-09-09 20:46:31
Triggering Job
Last updated: 2025-09-09 20:46:31
Feature Description
Batch data processing job triggered by a workflow.
Authorization Description
When using a sub-account, you need to add the ci:TriggerMediaWorkflow permission to the action in the authorization policy. For all supported Cloud Infinite (CI) API operations, see CI action.
Activating a Service
To use this feature, you need to bind a bucket in advance and enable Cloud Infinite (CI) service.
Note:
Note: After binding Cloud Infinite, if you manually perform bucket unbind, you will not be able to continue using this function.
Use Limits
When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.
﻿
﻿
Request
Request Sample
POST /inventorytriggerjob HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
﻿
<body>
Note:
Authorization: Auth String. For details, see Request Signature document.
Request Header
This API only uses common request headers. For details, see Common Request Headers documentation.
Request Body
The implementation of this request operation requires the following request body.
<Request>
    <Name>demo</Name>
    <Type>Workflow</Type>
    <Input>
        <Prefix>input</Prefix>
    </Input>
    <Operation>
        <TimeInterval>
            <Start>2022-02-01T12:00:00+0800</Start>
            <End>2022-05-01T12:00:00+0800</End>
        </TimeInterval>
        <WorkflowIds>w7476ff3564ee45b7b490d64bccaba6cc</WorkflowIds>  
    </Operation>
</Request>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
The specific data description of the Container type Request is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Name
Request
Batch trigger task name, supports Chinese, English, digits, — and _, length limited to 128 characters.
String
Yes
Type
Request
Batch processing task type: Workflow
String
No
Input
Request
Media information to be operated
Container
Yes
Operation
Request
Operation rule
Container
Yes
The specific data description of the Container type Input
 is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Manifest
Request.Input
COS inventory list filename COS inventory generation manifest.json file
String
No
UrlFile
Request.Input
URL filename Each line in the file contains a URL that is the access address of an object in COS
String
No
Prefix
Request.Input
Object prefix
String
No
Object
Request.Input
media file name
String
No
The specific data description of the Container type Operation
 is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
WorkflowIds
Request.Operation
Triggered workflow ID. For details, see create workflow﻿
String
Yes
TimeInterval
Request.Operation
Time-filtered trigger range
Container
No
The specific data description of the Container type TimeInterval is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Start
Request.TimeInterval
Start time. Format: %Y-%m-%dT%H:%m:%S%z, for example: 2001-01-01T00:00:00+0800.
String
No
End
Request.TimeInterval
End time. Format: %Y-%m-%dT%H:%m:%S%z, for example: 2001-01-01T00:00:00+0800.
String
No
Response
Response Headers
This API only returns the public response header. For details, see Common Response Headers documentation.
Response Body
The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <Type>Workflow</Type>
        <Name>demo</Name>
        <JobId>b3deffea2f84911ec9cb15254008618d9</JobId>
        <State>Running</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <Input>
            <Prefix>input</Prefix>
        </Input>
        <Operation>
            <TimeInterval>
                <Start>2022-02-01T12:00:00+0800</Start>
                <End>2022-05-01T12:00:00+0800</End>
            </TimeInterval>
            <WorkflowIds>w7476ff3564ee45b7b490d64bccaba6cc</WorkflowIds>  
        </Operation>
    </JobsDetail>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
JobsDetail
Response
Job details
Container
The content of Container node JobsDetail
:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
Error code, this parameter is valid only when State is Failed
String
Message
Response.JobsDetail
Error description, this parameter is valid only when State is Failed
String
Type
Response.JobsDetail
Batch processing task type
String
Name
Response.JobsDetail
Newly created task name
String
JobId
Response.JobsDetail
Newly created task ID
String
State
Response.JobsDetail
Task status.
Submitted: pending execution
Running: executing
Success: Execution successful
Failed: Execution failed
Pause: Task is paused. When the queue is paused, to be executed tasks change to paused state.
Cancel: Task execution cancelled
String
CreationTime
Response.JobsDetail
Task creation time
String
StartTime
Response.JobsDetail
Task start time
String
EndTime
Response.JobsDetail
Task end time
String
Input
Response.JobsDetail
﻿Request.Input in request
Container
Operation
Response.JobsDetail
﻿Request.Operation in request
Container
Error Codes
This request returns common error responses and error codes. For more information, see Error Codes.
Examples
Request
POST /inventorytriggerjob HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************************
Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
﻿
<Request>
    <Name>demo</Name>
    <Type>Workflow</Name>
    <Input>
        <Prefix>input</Prefix>
    </Input>
    <Operation>
        <TimeInterval>
            <Start>2022-02-01T12:00:00+0800</Start>
            <End>2022-05-01T12:00:00+0800</End>
        </TimeInterval>
        <WorkflowIds>w7476ff3564ee45b7b490d64bccaba6cc</WorkflowIds>  
    </Operation>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
﻿
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Type>Workflow</Type>
        <Message/>
        <Name>demo</Name>
        <JobId>b3deffea2f84911ec9cb15254008618d9</JobId>
        <State>Running</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <Input>
            <Prefix>input</Prefix>
        </Input>
        <Operation>
            <TimeInterval>
                <Start>2022-02-01T12:00:00+0800</Start>
                <End>2022-05-01T12:00:00+0800</End>
            </TimeInterval>
            <WorkflowIds>w7476ff3564ee45b7b490d64bccaba6cc</WorkflowIds>  
        </Operation>
    </JobsDetail>
</Response>
﻿
﻿
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
Feedback
Node Name (Keyword)	Parent Node	Description	Type	Required or Not
Request	None.	Container for saving requests	Container	Yes
tencent cloud

Feature Description

Authorization Description

Activating a Service

Use Limits

Request

Request Sample

Request Header

Request Body

Response

Response Headers

Response Body

Error Codes

Examples

Request

Response
