调用ListTemplates API获取模板列表-资源编排-阿里云

查询私有与共享的模板列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ros:ListTemplates

list

*Template

acs:ros:{#regionId}:{#accountId}:template/*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	模板列表的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。取值范围：1~50。默认值：10。	10
TemplateName	string	否	模板名称。仅在 ShareType 为 Private 时生效。长度不超过 255 个字符，必须以数字或英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）。	MyTemplate
ShareType	string	否	模板的共享类型。取值： Private（默认值）：模板为用户自己所拥有。 Shared：模板由其他用户所共享。 Official：官方共享模板。	Private
Tag	array<object>	否	标签。最多支持指定 20 个标签。
	object	否	标签。
Key	string	否	标签键。仅在 ShareType 为 Private 时生效。最多支持指定 20 个标签键。	usage
Value	string	否	标签值。仅在 ShareType 为 Private 时生效。最多支持指定 20 个标签值。	deploy
ResourceGroupId	string	否	资源组 ID。关于资源组的更多信息，请参见什么是资源组。	rg-acfmxazb4ph6aiy****
IncludeTags	string	否	是否查询标签信息。取值： Enabled：查询。 Disabled（默认值）：不查询。	Enabled
Filters	array<object>	否	过滤器。
	object	否	过滤器。
Name	string	否	过滤器名称，可选择一个或者多个名称进行查询。取值范围： Categories：模板分类 DeployTypes：部署类型 ApplicationScenes：应用场景 BasicServices：基础服务 ResourceTypes：资源类型 TemplateNames：模板名称	Categories
Values	array	否	过滤器值列表。
	string	否	过滤器值列表。N 的取值范围：1~10。	ROS

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	模板总数。	1
PageSize	integer	分页查询时设置的每页行数。	10
RequestId	string	请求 ID。	C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumber	integer	模板列表的页码。起始值：1。	1
Templates	array<object>	模板列表。
	array<object>	模板列表。
TemplateARN	string	模板的 ARN。	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
UpdateTime	string	模板最后更新时间。	2019-10-15T08:17:14.000000
Description	string	模板描述。	test-description
CreateTime	string	创建时间。	2019-10-15T08:17:14.000000
TemplateName	string	模板名称。	demo
TemplateVersion	string	模板最新版本名。	v1
TemplateId	string	模板 ID。	4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerId	string	模板所属阿里云账号 ID。	151266687691****
ShareType	string	模板的共享类型。取值： Private：模板为用户自己所拥有。 Shared：模板由其他用户所共享。	Private
ResourceGroupId	string	资源组 ID。	rg-acfmxazb4ph6aiy****
Tags	array<object>	模板的标签。
	object	模板的标签。
Key	string	模板的标签键。	usage
Value	string	模板的标签值。	test
AdditionalInfo	object	公共模板的补充信息。	{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["其他"]},"Provider":"ROS","Categories":["Solution"]}
TemplateUrl	string	模板的链接。	https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "PageNumber": 1,
  "Templates": [
    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "UpdateTime": "2019-10-15T08:17:14.000000",
      "Description": "test-description",
      "CreateTime": "2019-10-15T08:17:14.000000",
      "TemplateName": "demo",
      "TemplateVersion": "v1",
      "TemplateId": "4d4f5aa2-3260-4e47-863b-763fbb12****",
      "OwnerId": "151266687691****",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "usage",
          "Value": "test"
        }
      ],
      "AdditionalInfo": {
        "DeploymentDuration": null,
        "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
        "Labels": {
          "ResourceTypes": [
            "ALIYUN::ECS::Instance",
            "ALIYUN::ECS::SecurityGroup",
            "ALIYUN::ECS::VPC",
            "ALIYUN::ECS::VSwitch",
            "ALIYUN::OSS::Bucket",
            "ALIYUN::ROS::WaitCondition",
            "ALIYUN::ROS::WaitConditionHandle"
          ],
          "DeployTypes": [
            "ROS"
          ],
          "ApplicationScenes": [
            "其他"
          ]
        },
        "Provider": "ROS",
        "Categories": [
          "Solution"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。