tencent cloud

Pulling Jobs in Batches
Last updated: 2025-11-19 19:52:04
Pulling Jobs in Batches
Last updated: 2025-11-19 19:52:04

Feature Description

Pull the batch data processing job list.

Authorization Description

When using a sub-account, you need to add the ci:DescribeInventoryTriggerJobs permission to the action in the authorization policy. For details, see Cloud Infinite action.

Activating a Service

To use this feature, you need to bind a bucket in advance and enable Cloud Infinite service.
Note:
Note: After binding Cloud Infinite (CI), if you manually perform unbind on the bucket, 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

GET /inventorytriggerjob?size=&states=&startCreationTime=&endCreationTime= HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>

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

This request has no request body.

Request Parameters

The specific content of the parameter is as follows:
Name
Description
Type
Required or Not
nextToken
Request context, used for pagination. Returned value from last time.
String
No
size
Maximum number of tasks pulled. Default is 10. Maximum is 100.
Integer
No
type
Pull batch task types, workflow type Workflow, job type Job
String
No
orderByTime
Sorting method of the sorting field. Values as follows:
Asc: ascending order;
Desc (default): descending order.
String
No
states
Pull tasks in the status, support multiple statuses, separate different statuses with ,. Valid values include:
All (default value): includes all states below
Submitted: submitted, pending execution
Running: executing
Success: execution successful
Failed: execution failed
Pause: task pause. When the queue is paused, to be executed tasks change to paused state.
Cancel: task cancelled
String
No
startCreationTime
Pull tasks with a creation time greater than or equal to this time. Format: %Y-%m-%dT%H:%M:%S%z
String
No
endCreationTime
Pull tasks created at or before this time. Format: %Y-%m-%dT%H:%M:%S%z
String
No
workflowId
workflow ID. For details, see create workflow
String
No
jobId
Batch trigger task ID. For details, see trigger task (independent node) or trigger task (workflow)
String
No
name
Batch triggered task name
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>
    <RequestId></RequestId>
    <JobsDetail>
    ...
    </JobsDetail>
    <NextToken></NextToken>
</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
Task details
Container array
NextToken
Response
Pagination context Token
String
For different trigger modes, the content of JobsDetail varies. Please refer to the following link:
Workflow
Independent task

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

GET /inventorytriggerjob HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
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=**************************************************

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=

<Response>
    <RequestId>NjJiZDU1ZmZfOTBmYTUwNjRfNzdjY18xYQ==</RequestId>
    <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>
    <JobsDetail>
        <Code>Success</Code>
        <Type>Job</Type>
        <Message/>
        <Name>demo</Name>
        <JobId>be8f65004eb8511eaaed4f377124a303c</JobId>
        <State>Running</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>2022-06-27T15:23:11+0800</StartTime>    
        <EndTime>2022-06-27T15:25:10+0800</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>
            <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
            <UserData>this is my inventorytriggerjob</UserData>
            <CallBack>https://www.callback.com</CallBack>
            <JobParam>
                <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            </JobParam>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-1234567890</Bucket>
                <Object>output/${InventoryTriggerJobId}/out.mp4</Object>
            </Output>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
    <NextToken>25</NextToken>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback