调用ListTemplates查询模板_系统运维管理(OOS)-阿里云帮助中心

支持多种过滤方式。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oos:ListTemplates	get	Template acs:oos:{#regionId}:{#accountId}:template/* Template acs:oos:{#regionId}:{#accountId}:template/{#templateName}	oos:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID	cn-hangzhou
TemplateName	string	否	模板名称。列出含所填模板名称的所有模板。	MyTemplate
TemplateFormat	string	否	模板格式。取值范围： JSON YAML	YAML
ShareType	string	否	分享类型。取值范围： Public Private	Private
CreatedBy	string	否	模板创建者。对于阿里云官方提供的模板，为 ACS 对于用户个人创建的模板，可填写 UID 进行筛选，或填写用户名称进行筛选	ACS
CreatedDateBefore	string	否	创建时间小于等于指定时间的模板。格式为：YYYY-MM-DDThh:mm::ssZ	2019-05-16T10:26:14Z
CreatedDateAfter	string	否	创建时间大于等于指定时间的模板。格式为：YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
Tags	object	否	标签键及值，键值对数量限制为 1 至 20。	{"k1":"k2","k2":"v2"}
Category	string	否	模版类型如 TimerTrigger，EventTrigger，AlarmTrigger，Other。	TimerTrigger
MaxResults	integer	否	分页大小。取值范围：10-100。默认为 50。	50
NextToken	string	否	对查询结果进行翻页时需要传入的 Token 值，如有则获取自当前页的返回值。	xxx
SortField	string	否	排序字段。取值范围： TotalExecutionCount（默认值）：总执行次数 Popularity：受欢迎程度 TemplateName：模板名称 CreatedDate：创建时间 UpdatedDate：更新时间	Popularity
SortOrder	string	否	排序方向。取值范围： Ascending：升序 Descending（默认值）：降序	Descending
HasTrigger	boolean	否	是否触发	true
TemplateType	string	否	模版类型： Automation：自动化 State：配置清单 Package：软件包	Automation
ResourceGroupId	string	否	资源组 ID。	rg-acfmxsn4m4******
IsFavorite	boolean	否	是否已收藏	true
IsExample	boolean	否	是否是示例模板

返回参数

名称	类型	描述	示例值
	object
NextToken	string	对查询结果进行翻页时需要传入的 Token 值，如有则获取自当前页的返回值。	xxx
RequestId	string	请求 ID	BEF54BA-17B6-449F-A219-49ACB157E3
MaxResults	integer	分页大小。	50
Templates	array<object>	模板元信息
Template	object
Hash	string	模板内容的 SHA256	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	模板更新时间	2019-05-16T10:26:14Z
UpdatedBy	string	模板更新者	root(13092000)
TemplateType	string	模版类型	private
Tags	object	标签键及值，键值对数量限制为 1 至 20。	{"k1":"v1","k2":"v2"}
TemplateName	string	模板名称	MyTemplate
TemplateVersion	string	模板版本。以“v”+数字的形式，数字从 1 开始。	v1
TemplateFormat	string	模板格式。系统字段判断，为 JSON 或 YAML。	JSON
Popularity	integer	公共模板受欢迎程度。范围是1-10，数字越高表示越受欢迎。若 ShareType 为 Private，该字段值为`-1`。说明该字段在 ShareType 为 Public 时有意义。	8
TotalExecutionCount	integer	私有模板总执行次数。若 ShareType 为 Public，该字段值为`-1`。说明该字段在 ShareType 为 Private 时有意义。	5
Description	string	模板说明	Describe instances of given status
ResourceGroupId	string	资源组 ID	rg-acfmxsn4m4******
CreatedBy	string	模板创建者	root(1309200)
CreatedDate	string	模板创建时间	2019-05-16T10:26:14Z
Category	string	模版类型	TimerTrigger
HasTrigger	boolean	是否成功触发	true
TemplateId	string	模板 ID	t-94753deed38
ShareType	string	模板共享类型。目前用户创建的模板的共享类型均为 Private。取值范围： Public Private	Public
IsFavorite	boolean	是否已收藏	true
Publisher	string	发布者	aliyun
Constraints	string	约束条件	{ "InstanceTypeFamilies": ["ecs.g8y", "ecs.c8y"], "ImageTypes": ["system"], "OSPlatforms": ["CentOS", "Ubuntu"], "OSVersions": ["CentOS7.9 64bit"] }

示例

正常返回示例

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",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "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",
      "IsFavorite": true,
      "Publisher": "aliyun",
      "Constraints": "{\n  \"InstanceTypeFamilies\": [\"ecs.g8y\", \"ecs.c8y\"],\n  \"ImageTypes\": [\"system\"],\n  \"OSPlatforms\": [\"CentOS\", \"Ubuntu\"],\n  \"OSVersions\": [\"CentOS7.9 64bit\"]\n}",
      "VersionName": ""
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-11	OpenAPI 入参发生变更	查看变更详情
2023-12-08	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情