调用ListTemplates查询模板,支持多种过滤方式。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTemplates

系统规定参数。取值:ListTemplates

RegionId String cn-hangzhou

地域ID

TemplateName String MyTemplate

模板名称。列出含所填模板名称的所有模板。

TemplateFormat String YAML

模板格式。取值范围:

  • JSON
  • YAML
ShareType String Private

分享类型。取值范围:

  • Public
  • Private
CreatedBy String ACS

模板创建者。

  • 对于阿里云官方提供的模板,为ACS
  • 对于用户个人创建的模板,可填写 UID 进行筛选,或填写 用户名称 进行筛选
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 Map {"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

排序字段。取值范围:

  • TotalExecutionCount(默认值):总执行次数
  • Popularity:受欢迎程度
  • TemplateName:模板名称
  • CreatedDate:创建时间
SortOrder String Descending

排序方向。取值范围:

  • Ascending:升序
  • Descending(默认值):降序
HasTrigger Boolean true

是否触发

TemplateType String private

模版类型

ResourceGroupId String rg-acfmxsn4m4******

资源组ID。

返回数据

名称 类型 示例值 描述
NextToken String xxx

对查询结果进行翻页时需要传入的Token值,如有则获取自当前页的返回值。

RequestId String BEF54BA-17B6-449F-A219-49ACB157E3

请求ID

MaxResults Integer 50

分页大小。

Templates Array of Template

模板元信息

Hash String 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4

模板内容的SHA256

UpdatedDate String 2019-05-16T10:26:14Z

模板更新时间

UpdatedBy String root(13092000)

模板更新者

TemplateType String private

模版类型

Tags Map

标签键及值,键值对数量限制为1至20。

TemplateName String MyTemplate

模板名称

TemplateVersion String v1

模板版本。以“v”+数字的形式,数字从1开始。

TemplateFormat String JSON

模板格式。系统字段判断,为JSON或YAML。

Popularity Integer 8

公共模板受欢迎程度。范围是1-10,数字越高表示越受欢迎。若ShareTypePrivate,该字段值为-1

说明 该字段在ShareTypePublic时有意义。
TotalExecutionCount Integer 5

私有模板总执行次数。若ShareTypePublic,该字段值为-1

说明 该字段在ShareTypePrivate时有意义。
Description String Describe instances of given status

模板说明

ResourceGroupId String rg-acfmxsn4m4******

资源组ID

CreatedBy String root(1309200)

模板创建者

CreatedDate String 2019-05-16T10:26:14Z

模板创建时间

Category String TimerTrigger

模版类型

HasTrigger Boolean true

是否成功触发

TemplateId String t-94753deed38

模板ID

ShareType String Public

模板共享类型。目前用户创建的模板的共享类型均为 Private。取值范围:

  • Public
  • Private

示例

请求示例

http(s)://[Endpoint]/?Action=ListTemplates
&RegionId=cn-hangzhou
&TemplateName=MyTemplate
&TemplateFormat=YAML
&ShareType=Private
&CreatedBy=ACS
&CreatedDateBefore=2019-05-16T10:26:14Z
&CreatedDateAfter=2019-05-16T10:26:14Z
&Category=TimerTrigger
&MaxResults=50
&NextToken=xxx
&SortField=Popularity
&SortOrder=Descending
&HasTrigger=true
&TemplateType=private
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTemplatesResponse>
    <NextToken>xxx</NextToken>
    <RequestId>BEF54BA-17B6-449F-A219-49ACB157E3</RequestId>
    <MaxResults>50</MaxResults>
    <Templates>
        <Hash>4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4</Hash>
        <UpdatedDate>2019-05-16T10:26:14Z</UpdatedDate>
        <UpdatedBy>root(13092000)</UpdatedBy>
        <TemplateType>private</TemplateType>
        <TemplateName>MyTemplate</TemplateName>
        <TemplateVersion>v1</TemplateVersion>
        <TemplateFormat>JSON</TemplateFormat>
        <Popularity>8</Popularity>
        <TotalExecutionCount>5</TotalExecutionCount>
        <Description>Describe instances of given status</Description>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <CreatedBy>root(1309200)</CreatedBy>
        <CreatedDate>2019-05-16T10:26:14Z</CreatedDate>
        <Category>TimerTrigger</Category>
        <HasTrigger>true</HasTrigger>
        <TemplateId>t-94753deed38</TemplateId>
        <ShareType>Public</ShareType>
    </Templates>
</ListTemplatesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "xxx",
  "RequestId" : "BEF54BA-17B6-449F-A219-49ACB157E3",
  "MaxResults" : 50,
  "Templates" : [ {
    "Hash" : "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
    "UpdatedDate" : "2019-05-16T10:26:14Z",
    "UpdatedBy" : "root(13092000)",
    "TemplateType" : "private",
    "TemplateName" : "MyTemplate",
    "TemplateVersion" : "v1",
    "TemplateFormat" : "JSON",
    "Popularity" : 8,
    "TotalExecutionCount" : 5,
    "Description" : "Describe instances of given status",
    "ResourceGroupId" : "rg-acfmxsn4m4******",
    "CreatedBy" : "root(1309200)",
    "CreatedDate" : "2019-05-16T10:26:14Z",
    "Category" : "TimerTrigger",
    "HasTrigger" : true,
    "TemplateId" : "t-94753deed38",
    "ShareType" : "Public"
  } ]
}

错误码

访问错误中心查看更多错误码。