调用ListTemplates查询模板,支持多种过滤方式。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListTemplates |
系统规定参数。取值:ListTemplates。 |
RegionId | String | 否 | cn-hangzhou |
地域ID |
TemplateName | String | 否 | MyTemplate |
模板名称。列出含所填模板名称的所有模板。 |
TemplateFormat | String | 否 | YAML |
模板格式。取值范围:
|
ShareType | String | 否 | Private |
分享类型。取值范围:
|
CreatedBy | String | 否 | ACS |
模板创建者。
|
CreatedDateBefore | String | 否 | 2019-05-16T10:26:14Z |
创建时间小于等于指定时间的模板。 格式为:YYYY-MM-DDThh:mm::ssZ |
CreatedDateAfter | String | 否 | 2019-05-16T10:26:14Z |
创建时间大于等于指定时间的模板。 格式为:YYYY-MM-DDThh:mm:ssZ |
Tags | Json | 否 | {"k1":"k2","k2":"v2"} |
标签键及值,键值对数量限制为1至20。 |
Category | String | 否 | TimerTrigger |
模版类型如TimerTrigger,EventTrigger,AlarmTrigger,Other。 |
MaxResults | Integer | 否 | 50 |
分页大小。取值范围:20-100。默认为50。 |
NextToken | String | 否 | xxx |
对查询结果进行翻页时需要传入的Token值,如有则获取自当前页的返回值。 |
SortField | String | 否 | Popularity |
排序字段。取值范围:
|
SortOrder | String | 否 | Descending |
排序方向。取值范围:
|
HasTrigger | Boolean | 否 | true |
是否触发 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
MaxResults | Integer | 50 |
分页大小。 |
NextToken | String | xxx |
对查询结果进行翻页时需要传入的Token值,如有则获取自当前页的返回值。 |
RequestId | String | BEF54BA-17B6-449F-A219-49ACB157E3 |
请求ID |
Templates | Array |
模板元信息 |
|
Category | String | TimerTrigger |
模版类型 |
CreatedBy | String | root(1309200) |
模板创建者 |
CreatedDate | String | 2019-05-16T10:26:14Z |
模板创建时间 |
Description | String | Describe instances of given status |
模板说明 |
HasTrigger | Boolean | true |
是否成功触发 |
Hash | String | 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 |
模板内容的SHA256 |
Popularity | Integer | 8 |
公共模板模板受欢迎程度。范围是1-10,数字越高表示越受欢迎。若ShareType为Private,该字段值为 说明 该字段在ShareType为Public时有意义。
|
ShareType | String | Public |
模板共享类型。目前用户创建的模板的共享类型均为 Private。取值范围:
|
Tags | Map | {"k1":"v1","k2":"v2"} |
标签键及值,键值对数量限制为1至20。 |
TemplateFormat | String | JSON |
模板格式。系统字段判断,为JSON或YAML。 |
TemplateId | String | t-94753deed38 |
模板ID |
TemplateName | String | MyTemplate |
模板名称 |
TemplateVersion | String | v1 |
模板版本。以“v”+数字的形式,数字从1开始。 |
TotalExecutionCount | Integer | 5 |
私有模板总执行次数。若ShareType为Public,该字段值为 说明 该字段在ShareType为Private时有意义。
|
UpdatedBy | String | root(13092000) |
模板更新者 |
UpdatedDate | String | 2019-05-16T10:26:14Z |
模板更新时间 |
示例
请求示例
http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=ListTemplates
&<公共请求参数>&TemplateName=templateName1
正常返回示例
XML
格式
<ListTemplatesResponse>
<MaxResults>50</MaxResults>
<RequestId>BEF54BA-17B6-449F-A219-49ACB157E3</RequestId>
<Templates>
<CreatedBy>root(13090000)</CreatedBy>
<CreatedDate>2019-05-14T09:16:37Z</CreatedDate>
<UpdatedBy>root(130900000)</UpdatedBy>
<UpdatedDate>2019-05-27T08:46:33Z</UpdatedDate>
<Description></Description>
<Hash>d02b84917e5a82c672630bf041a61dd5dc52fbc481ff98516c6a81876f3d9c01</Hash>
<ShareType>Private</ShareType>
<TemplateFormat>JSON</TemplateFormat>
<TemplateName>MyTemplate</TemplateName>
<TemplateId>t-94753dd828d38</TemplateId>
<TemplateVersion>v1</TemplateVersion>
<TotalExecutionCount>0</TotalExecutionCount>
<Popularity>-1</Popularity>
</Templates>
</ListTemplatesResponse>
JSON
格式
{
"MaxResults": 50,
"RequestId": "BEF54BA-17B6-449F-A219-49ACB157E3",
"Templates": [
{
"CreatedBy": "root(13090000)",
"CreatedDate": "2019-05-14T09:16:37Z",
"UpdatedBy": "root(130900000)",
"UpdatedDate": "2019-05-27T08:46:33Z",
"Description": "",
"Hash": "d02b84917e5a82c672630bf041a61dd5dc52fbc481ff98516c6a81876f3d9c01",
"ShareType": "Private",
"TemplateFormat": "JSON",
"TemplateName": "MyTemplate",
"TemplateId": "t-94753dd828d38",
"TemplateVersion": "v1",
"TotalExecutionCount": 0,
"Popularity": -1
}]
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交