功能描述
查询模板。
请求
请求示例
GET /template HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
请求头
请求体
该请求的请求体为空。
请求参数
参数的具体内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 |
tag | 无 | 模板类型,默认值: All | String | 否 |
category | 无 | Official(系统预设模板),Custom(自定义模板),默认值: Custom | String | 否 |
ids | 无 | 模板 ID,以 , 符号分割字符串 | String | 否 |
name | 无 | 模板名称前缀 | String | 否 |
pageNumber | 无 | 第几页,默认值:1 | Integer | 否 |
pageSize | 无 | 每页个数,默认值:10 | Integer | 否 |
tag 支持以下几种类型:
模板类型 | tag |
图片处理 | PicProcess |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId><TotalCount>2</TotalCount><PageNumber>1</PageNumber><PageSize>10</PageSize><TemplateList><Tag>PicProcess</Tag><TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/90</ProcessRule></PicProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList><TemplateList><Tag>PicProcess</Tag><TemplateId>t1a30a323f55434a29b25bf2a16bdf5f59</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/45</ProcessRule></PicProcess><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 数组 |
错误码
实际案例
案例一:按照模板 ID 维度查询
请求
GET /template?ids=t1847cd4ca57f543e89f551dbe68169eb9,t1a30a323f55434a29b25bf2a16bdf5f59,C HTTP/1.1Authorization: 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=28e9a4986df11bed0255e97ff90500557e0e****Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId><TemplateList><Tag>PicProcess</Tag><TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/90</ProcessRule></PicProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList><TemplateList><Tag>PicProcess</Tag><TemplateId>t1a30a323f55434a29b25bf2a16bdf5f59</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/45</ProcessRule></PicProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList><NonExistTIDs><TemplateId>C</TemplateId></NonExistTIDs></Response>
案例二:按照分页列表维度查询
请求
GET /template?pageSize=10&pageNumber=1 HTTP/1.1Authorization: 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=28e9a4986df11bed0255e97ff90500557e0e****Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId><TotalCount>2</TotalCount><PageNumber>1</PageNumber><PageSize>10</PageSize><TemplateList><Tag>PicProcess</Tag><TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/90</ProcessRule></PicProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList><TemplateList><Tag>PicProcess</Tag><TemplateId>t1a30a323f55434a29b25bf2a16bdf5f59</TemplateId><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><PicProcess><IsPicInfo>true</IsPicInfo><ProcessRule>imageMogr2/rotate/45</ProcessRule></PicProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList></Response>