LISTJobs

最近更新时间:2019-11-04 17:10:35

功能描述

用于拉取符合条件的任务列表。

请求

请求示例

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

Authorization: Auth String (详情请查阅 请求签名 文档)。

请求头

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

请求体

该请求无请求体。

请求参数

参数的具体内容如下:

节点名称(关键字) 父节点 描述 类型 是否必选
queueId 拉取该队列 ID 下的任务。 String
tag 任务的 Tag:Animation 或者 Snapshot。 String
orderByTime Desc 或者 Asc。默认为 Desc。 String
nextToken 请求的上下文,用于翻页。上次返回的值。 String
size 拉取的最大任务数。默认为10。最大为100。 Integer
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

响应

响应头

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

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

<Response>
  <JobsDetail></JobsDetail>
  <NextToken></NextToken>
</Response>

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型
Response 保存结果的容器 Container

Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
JobsDetail Response 任务的详细信息,同 PostJobs 接口中的 Response.JobsDetail 节点 Container
NextToken Response 翻页的上下文 Token String

错误码

相关请求产生的错误码信息请参见 错误码 文档。

实际案例

请求

GET /jobs?queueId=aaaaaaaaaaa&tag=Animation HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR98JM&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: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=

<Response>
  <JobsDetail>
    <Code>Success</Code>
    <Message>Success</Message>
    <JobId>jabcsdssfeipplsdfwe</JobId>
    <State>Submitted</State>
    <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
    <QueueId>pssefffensldddsfessgg</QueueId>
    <Tag>Snapshot</Tag>
    <Input>
      <Object>test.mp4</Object>
    </Input>
    <Operation>
      <TemplateId>taaaabkkenskdixxkskdf</TemplateId>
      <Output>
        <Region>ap-beijing</Region>
        <Bucket>abc-1250000001</Bucket>
        <Object>test-trans.mkv</Object>
      </Output>
    </Operation>
  </JobsDetail>
  <JobsDetail>
    <Code>Success</Code>
    <Message>Success</Message>
    <JobId>jbbbbccddabcddafesff</JobId>
    <State>Submitted</State>
    <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
    <QueueId>pssefffensldddsfessgg</QueueId>
    <Tag>Snapshot</Tag>
    <Input>
      <Object>test.mp4</Object>
    </Input>
    <Operation>
      <TemplateId>taaaabkkenskdixxkskdf</TemplateId>
      <Output>
        <Region>ap-beijing</Region>
        <Bucket>abc-1250000001</Bucket>
        <Object>test-trans.mkv</Object>
      </Output>
    </Operation>
  </JobsDetail>
</Response>