全部产品
Search
文档中心

资源编排:ListTemplates - 查询模板列表

更新时间:Feb 22, 2024

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

调试

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

授权信息

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

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

请求参数

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

模板列表的页码。
起始值:1。
默认值:1。

1
PageSizelong

分页查询时设置的每页行数。
取值范围:1~50。
默认值:10。

10
TemplateNamestring

模板名称。仅在 ShareType 为 Private 时生效。 长度不超过 255 个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。

MyTemplate
ShareTypestring

模板的共享类型。

取值:

  • Private(默认值):模板为用户自己所拥有。
  • Shared:模板由其他用户所共享。
  • Official:官方共享模板。
Private
Tagobject []

标签。最多支持指定 20 个标签。

Keystring

标签键。仅在 ShareType 为 Private 时生效。

最多支持指定 20 个标签键。

usage
Valuestring

标签值。仅在 ShareType 为 Private 时生效。

最多支持指定 20 个标签值。

deploy
ResourceGroupIdstring

资源组 ID。
关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****
IncludeTagsstring

是否查询标签信息。取值:

  • Enabled:查询。
  • Disabled(默认值):不查询。
Enabled

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

返回参数

名称类型描述示例值
object
TotalCountinteger

模板总数。

1
PageSizeinteger

分页查询时设置的每页行数。

10
RequestIdstring

请求 ID。

C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumberinteger

模板列表的页码。
起始值:1。

1
Templatesobject []

模板列表。

TemplateARNstring

模板的 ARN。

acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****
UpdateTimestring

模板最后更新时间。

2019-10-15T08:17:14.000000
Descriptionstring

模板描述。

test-description
CreateTimestring

创建时间。

2019-10-15T08:17:14.000000
TemplateNamestring

模板名称。

demo
TemplateVersionstring

模板最新版本名。

v1
TemplateIdstring

模板 ID。

4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerIdstring

模板所属阿里云账号 ID。

151266687691****
ShareTypestring

模板的共享类型。

取值:

  • Private:模板为用户自己所拥有。
  • Shared:模板由其他用户所共享。
Private
ResourceGroupIdstring

资源组 ID。

rg-acfmxazb4ph6aiy****
Tagsobject []

模板的标签。

Keystring

模板的标签键。

usage
Valuestring

模板的标签值。

test

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-06-09OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:IncludeTags
出参OpenAPI 返回结构发生变更