tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    DescribePicJobs

    Last updated: 2024-06-12 15:47:04
    Download PDF

      Feature Description

      The API (DescribePicJobs) is used to pull jobs that meet specified conditions.

      Request

      Sample request

      GET /pic_jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1
      Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
      Date: <GMT Date>
      Authorization: <Auth String>
      
      Note:
      Authorization: Auth String (for more information, see Request Signature).
      When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.

      Request headers

      This API only uses common request headers. For more information, see Common Request Headers.

      Request body

      This request does not have a request body.

      Request parameters

      The nodes are as described below:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      queueId
      None
      ID of the queue from which jobs are pulled
      String
      Yes
      tag
      None
      Job type: PicProcess
      String
      Yes
      orderByTime
      None
      Valid values: Desc, Asc. Default value: Desc.
      String
      No
      nextToken
      None
      Context token for pagination
      String
      No
      size
      None
      Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100.
      Integer
      No
      States
      None
      Status of the jobs to pull. If you enter multiple job statuses, separate them by comma.
      Valid values: All, Submitted, Running, Success, Failed, Pause, Cancel. Default value: All.
      String
      No
      startCreationTime
      None
      Start time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z.
      String
      No
      endCreationTime
      None
      End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z.
      String
      No

      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>
        <JobsDetail>
        </JobsDetail>
        <NextToken></NextToken>
      </Response>
      The nodes are as described below:
      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
      JobsDetail
      Response
      Job details. Same as Response.JobsDetail in CreateMediaJobs.
      Container
      NextToken
      Response
      Context token for pagination
      String

      Error codes

      There are no special error messages for this request. For common error messages, see Error Codes.

      Samples

      Request

      GET /pic_jobs?queueId=aaaaaaaaaaa&tag=PicProcess 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
      

      Response

      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: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
      
      <Response>
        <JobsDetail>
          <Code>Success</Code>
          <Message>Success</Message>
          <JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
          <State>Submitted</State>
          <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
          <EndTime>2019-07-07T12:12:12+0800</EndTime>
          <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
          <Tag>PicProcess</Tag>
          <Input>
            <Object>test.jpg</Object>
          </Input>
          <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <Output>
              <Region>ap-beijing</Region>
              <Bucket>abc-1250000000</Bucket>
              <Object>picprocess.jpg</Object>
              <SpriteObject></SpriteObject>
            </Output>
          </Operation>
        </JobsDetail>
        <JobsDetail>
          <Code>Success</Code>
          <Message>Success</Message>
          <JobId>jbbbbccddabcddafesff</JobId>
          <State>Submitted</State>
          <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
          <EndTime>2019-07-07T12:12:12+0800</EndTime>
          <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
          <Tag>PicProcess</Tag>
          <Input>
            <Object>test.jpg</Object>
          </Input>
          <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <Output>
              <Region>ap-beijing</Region>
              <Bucket>abc-1250000000</Bucket>
              <Object>picprocess.jpg</Object>
              <SpriteObject></SpriteObject>
            </Output>
          </Operation>
        </JobsDetail>
      </Response>
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy