首页 运维编排服务 API参考 API目录 模板 ListTemplates - 查询模板

ListTemplates - 查询模板

支持多种过滤方式。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:ListTemplatesREAD
  • OOS
    acs:oos:{#regionId}:{#accountId}:template/*
  • OOS
    acs:oos:{#regionId}:{#accountId}:template/{#templateName}
  • oos:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID

cn-hangzhou
TemplateNamestring

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

MyTemplate
TemplateFormatstring

模板格式。取值范围:

  • JSON
  • YAML
YAML
ShareTypestring

分享类型。取值范围:

  • Public
  • Private
Private
CreatedBystring

模板创建者。

  • 对于阿里云官方提供的模板,为ACS
  • 对于用户个人创建的模板,可填写 UID 进行筛选,或填写 用户名称 进行筛选
ACS
CreatedDateBeforestring

创建时间小于等于指定时间的模板。

格式为:YYYY-MM-DDThh:mm::ssZ

2019-05-16T10:26:14Z
CreatedDateAfterstring

创建时间大于等于指定时间的模板。

格式为:YYYY-MM-DDThh:mm:ssZ

2019-05-16T10:26:14Z
Tagsobject

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

Categorystring

模版类型如TimerTrigger,EventTrigger,AlarmTrigger,Other。

TimerTrigger
MaxResultsinteger

分页大小。取值范围:20-100。默认为50。

50
NextTokenstring

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

xxx
SortFieldstring

排序字段。取值范围:

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

排序方向。取值范围:

  • Ascending:升序
  • Descending(默认值):降序
Descending
HasTriggerboolean

是否触发

true
TemplateTypestring

模版类型

private
ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
NextTokenstring

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

xxx
RequestIdstring

请求ID

BEF54BA-17B6-449F-A219-49ACB157E3
MaxResultsinteger

分页大小。

50
Templatesarray

模板元信息

object
Hashstring

模板内容的SHA256

4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDatestring

模板更新时间

2019-05-16T10:26:14Z
UpdatedBystring

模板更新者

root(13092000)
TemplateTypestring

模版类型

private
Tagsobject

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

TemplateNamestring

模板名称

MyTemplate
TemplateVersionstring

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

v1
TemplateFormatstring

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

JSON
Popularityinteger

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

说明该字段在ShareTypePublic时有意义。
8
TotalExecutionCountinteger

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

说明该字段在ShareTypePrivate时有意义。
5
Descriptionstring

模板说明

Describe instances of given status
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

模板创建者

root(1309200)
CreatedDatestring

模板创建时间

2019-05-16T10:26:14Z
Categorystring

模版类型

TimerTrigger
HasTriggerboolean

是否成功触发

true
TemplateIdstring

模板ID

t-94753deed38
ShareTypestring

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

  • Public
  • Private
Public

示例

请求示例

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******
&公共请求参数

正常返回示例

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"
        }
    ]
}

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>

错误码

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

阿里云首页 运维编排 相关技术圈