tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

批量拉取任务

最后更新时间：2023-12-30 16:20:58

    功能描述

    拉取批量数据处理任务列表。
    

    请求

    请求示例

    GET /inventorytriggerjob?size=&states=&startCreationTime=&endCreationTime= HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    
    说明：
    Authorization: Auth String（详情请参见 请求签名 文档）。
    通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。

    请求头

    此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

    请求体

    该请求无请求体。

    请求参数

    参数的具体内容如下：
    节点名称（关键字）
    父节点
    描述
    类型
    必选
    nextToken
    无
    请求的上下文，用于翻页。上次返回的值
    String
    否
    size
    无
    拉取的最大任务数。默认为10。最大为100
    Integer
    否
    type
    无
    拉取批量任务类型，工作流类型 Workflow 、任务类型 Job
    String
    否
    orderByTime
    无
    Desc 或者 Asc。默认为 Desc
    String
    否
    states
    无
    拉取该状态的任务，以,分割支持多状态 All，Submitted，Running，Success，Failed，Pause，Cancel。默认为 All
    String
    否
    startCreationTime
    无
    拉取创建时间大于等于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
    String
    否
    endCreationTime
    无
    拉取创建时间小于等于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
    String
    否
    workflowId
    无
    工作流 ID
    String
    否
    jobId
    无
    批量触发任务 ID
    String
    否
    name
    无
    批量触发任务名称
    String
    否

    响应

    响应头

    此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
    <Response>
        <RequestId></RequestId>
        <JobsDetail>
        ...
        </JobsDetail>
        <NextToken></NextToken>
    </Response>
    具体的数据内容如下：
    节点名称（关键字）
    父节点
    描述
    类型
    Response
    无
    保存结果的容器
    Container
    Container 节点 Response 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    RequestId
    Response
    请求的唯一 ID
    String
    JobsDetail
    Response
    任务的详细信息
    Container 数组
    NextToken
    Response
    翻页的上下文 Token
    String
    对于不同的触发方式，JobsDetail 的内容不同，请参照以下链接：
    工作流
    独立任务

    错误码

    该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

    实际案例

    请求

    GET /inventorytriggerjob 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=28e9a4986df11bed0255e97ff90500557e0ea057
    Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
    

    响应

    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>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款