tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Creating Intelligent Thumbnail Template

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

      Feature Description

      This API is used to create an intelligent thumbnail template.
      

      Request

      Sample request

      POST /template 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 more information, see Request Signature).
      When this feature is used by a sub-account, relevant permissions must be granted. For more information, see Authorization Granularity Details.

      Request headers

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

      Request body

      This request requires the following request body:
      <Request>
          <Tag>SmartCover</Tag>
          <Name>TemplateName</Name>
          <SmartCover>
              <Format>jpg</Format>
              <Width>1280</Width>
              <Height>960</Height>
              <Count>10</Count>
              <DeleteDuplicates>true</DeleteDuplicates>
          </SmartCover>
      </Request>
      The nodes are described as follows:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Request
      None
      Request container
      Container
      Yes
      
      Request
      has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Tag
      Request
      Template tag: SmartCover
      String
      Yes
      Name
      Request
      Template name, which can contain letters, digits, underscores (_), hyphens (-), and asterisks (*).
      String
      Yes
      SmartCover
      Request
      Intelligent thumbnail parameter
      Container
      Yes
      
      SmartCover
      has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      Format
      Request.SmartCover
      Image format
      String
      No
      jpg
      jpg, png, webp
      Width
      Request.SmartCover
      Width
      String
      No
      Original video width
      Value range: [128, 4096]
      Unit: px
      If only Width is set, Height is calculated based on the original video aspect ratio.
      Height
      Request.SmartCover
      Height
      String
      No
      Original video height
      Value range: [128, 4096]
      Unit: px
      If only Height is set, Width is calculated based on the original video aspect ratio.
      Count
      Request.SmartCover
      Number of screenshots
      String
      No
      3
      [1,10]
      DeleteDuplicates
      Request.SmartCover
      Whether to deduplicate thumbnails.
      String
      No
      false
      true/false

      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>
          <Template>
              <Tag>SmartCover</Tag>
              <Name>TemplateName</Name>
              <TemplateId>t1f43110a08702470b8fa75894629501fa</TemplateId>
              <BucketId>test-1234567890</BucketId>
              <Category>Custom</Category>
              <SmartCover>
                  <Width>1280</Width>
                  <Height>960</Height>
                  <Format>jpg</Format>
                  <Count>5</Count>
                  <DeleteDuplicates>false</DeleteDuplicates>
              </SmartCover>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </Template>
      </Response>
      The nodes are as described below:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Response
      None
      Result storage container
      Container
      
      Response
      has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Tag
      Response.Template
      Template tag: SmartCover
      String
      Name
      Response.Template
      Template name
      String
      BucketId
      Response.Template
      Template bucket
      String
      Category
      Response.Template
      Template category: Custom or Official
      String
      TemplateId
      Response.Template
      Template ID
      String
      UpdateTime
      Response.Template
      Update time
      String
      CreateTime
      Response.Template
      Creation time
      String
      SmartCover
      Response.Template
      Template parameter, which is the same as SmartCover in the request body.
      Container

      Error codes

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

      Samples

      Request

      POST /template 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: test-1234567890.ci.ap-beijing.myqcloud.com
      Content-Length: 1666
      Content-Type: application/xml
      
      <Request>
          <Tag>SmartCover</Tag>
          <Name>TemplateName</Name>
          <SmartCover>
              <Format>jpg</Format>
              <Width>1280</Width>
              <Height>960</Height>
              <Count>10</Count>
              <DeleteDuplicates>true</DeleteDuplicates>
          </SmartCover>
      </Request>

      Response

      HTTP/1.1 200 OK
      Content-Type: application/xml
      Content-Length: 100
      Connection: keep-alive
      Date: Thu, 14 Jul 2022 12:37:29 GMT
      Server: tencent-ci
      x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
      
      <Response>
          <Template>
              <Tag>SmartCover</Tag>
              <Name>TemplateName</Name>
              <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
              <BucketId>test-1234567890</BucketId>
              <Category>Custom</Category>
              <SmartCover>
                  <Format>jpg</Format>
                  <Width>1280</Width>
                  <Height>960</Height>
                  <Count>10</Count>
                  <DeleteDuplicates>true</DeleteDuplicates>
              </SmartCover>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </Template>
      </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