控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

搜索截图模板

最近更新时间:2021-04-14 16:58:50

功能描述

DescribeMediaTemplates 用于搜索截图模板。

请求

请求示例

GET /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

说明:

Authorization: Auth String (详情请参见 请求签名 文档)。

请求头

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

请求体

该请求的请求体为空。

请求参数

参数的具体内容如下:

节点名称(关键字) 父节点 描述 类型 必选
tag 模板 Tag:Snapshot String
category Official,Custom,默认值:Custom String
ids 模板 ID,以,符号分割字符串 String
name 模板名称前缀 String
pageNumber 第几页 Integer
pageSize 每页个数 Integer

响应

响应头

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

响应体

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

<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TemplateList>
        <TemplateId>A</TemplateId>
        <Name>TemplateName</Name>
        <Tag>Snapshot</Tag>
        <Snapshot>
            <Width>1280</Width>
            <Height></Height>
            <Start>0</Start>
            <TimeInterval></TimeInterval>
            <Count></Count>
        </Snapshot>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </TemplateList>
</Response>

具体的数据内容如下:

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

Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
RequestId Response 请求的唯一 ID String
TotalCount Response 模版总数 Int
PageNumber Response 当前页数,同请求中的 pageNumber Int
PageSize Response 每页个数,同请求中的 pageSize Int
TemplateList Response 模版数组 Container

Container 节点 TemplateList 的内容:

节点名称(关键字) 父节点 描述 类型
TemplateId Response.TemplateList 模版 ID String
Name Response.TemplateList 模版名字 String
BucketId Response.TemplateList 模版所属存储桶 String
Category Response.TemplateList 模版属性,Custom 或者 Official String
Tag Response.TemplateList 模版类型,Snapshot String
UpdateTime Response.TemplateList 更新时间 String
CreateTime Response.TemplateList 创建时间 String
Snapshot Response.TemplateList 其详细的模版参数 Container

Container 类型 Snapshot 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 必选 默认值 限制
Mode TemplateList.Snapshot 截图模式 String Interval
  • 值范围:{Interval, Average}
  • Interval 表示间隔模式 Average 表示平均模式
  • Interval模式:Start,TimeInterval,
    Count 参数生效。当设置 Count,
    未设置 TimeInterval 时,表示截取所有帧,共 Count 张图片
  • Average 模式:Start,Count 参数生效。表示从
    Start 开始到视频结束,按平均间隔截取共 Count 张图片
  • Start TemplateList.Snapshot 开始时间 String 0
  • [0 视频时长]
  • 单位为秒
  • 支持 float 格式,执行精度精确到毫秒
  • TimeInterval TemplateList.Snapshot 截图时间间隔 String
  • (0 3600]
  • 单位为秒
  • 支持 float 格式,执行精度精确到毫秒
  • Count TemplateList.Snapshot 截图数量 String (0 10000]
    Width TemplateList.Snapshot String 视频原
    始宽度
  • 值范围:[128,4096]
  • 单位:px
  • 若只设置 Width 时,按照视频原始比例计算 Height
  • Height TemplateList.Snapshot String 视频原
    始高度
  • 值范围:[128,4096]
  • 单位:px
  • 若只设置 Height 时,按照视频原始比例计算 Width
  • 错误码

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

    实际案例

    案例一:按照模板 ID 维度查询

    请求

    GET /template?ids=A,B,C 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
    Content-Length: 0
    Content-Type: application/xml
    

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 100
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    
    
    
    <Response>
        <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzh****=</RequestId>
        <TemplateList>
            <TemplateId>A</TemplateId>
            <Name>TemplateName</Name>
            <Tag>Snapshot</Tag>
            <Snapshot>
                <Width>1280</Width>
                <Height></Height>
                <Start>0</Start>
                <TimeInterval></TimeInterval>
                <Count></Count>
            </Snapshot>
            <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
            <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        </TemplateList>
        <NonExistTIDs>
            <TemplateId>B</TemplateId>
            <TemplateId>C</TemplateId>
        </NonExistTIDs>
    </Response>

    案例二:按照分页列表维度查询

    请求

    GET /template?page_size=10&page_number=1 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
    Content-Length: 0
    Content-Type: application/xml
    

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 100
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    
    
    
    <Response>
        <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzh****=</RequestId>
        <TotalCount>1</TotalCount>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TemplateList>
            <TemplateId>A</TemplateId>
            <Name>TemplateName</Name>
            <Tag>Snapshot</Tag>
            <Snapshot>
                <Width>1280</Width>
                <Height></Height>
                <Start>0</Start>
                <TimeInterval></TimeInterval>
                <Count></Count>
            </Snapshot>
            <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
            <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        </TemplateList>
    </Response>

    目录