调用ListTemplates接口查询模板列表。

调试

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

请求参数

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

要执行的操作,取值:ListTemplates。

PageNumber Long 1

模板列表的页码。

起始值:1。

默认值:1。

PageSize Long 10

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

取值范围:1~50。

默认值:10。

TemplateName String MyTemplate

模板名称。仅在ShareType为Private时生效。

长度不超过255个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。

ShareType String Private

模板的共享类型。

取值:

  • Private(默认值):模板为用户自己所拥有。
  • Shared:模板由其他用户所共享。
  • Official:官方共享模板。
Tag.N.Key String usage

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

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

Tag.N.Value String deploy

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

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

ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。

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

IncludeTags String Enabled

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

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

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

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

模板总数。

PageSize Integer 10

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

RequestId String C3A8413B-1F16-4DED-AC3E-61A00718DE8A

请求ID。

PageNumber Integer 1

模板列表的页码。

起始值:1。

Templates Array of Template

模板列表。

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

模板的ARN。

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 4d4f5aa2-3260-4e47-863b-763fbb12****

模板ID。

OwnerId String 151266687691****

模板所属阿里云账号ID。

ShareType String Private

模板的共享类型。

取值:

  • Private:模板为用户自己所拥有。
  • Shared:模板由其他用户所共享。
ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。

Tags Array of Tags

模板的标签。

Key String usage

模板的标签键。

Value String test

模板的标签值。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=ListTemplates
&<公共请求参数>

正常返回示例

XML格式

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

<ListTemplatesResponse>
    <TemplateARN>acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****</TemplateARN>
    <Description>ROS template for create ECS instance.</Description>
    <RequestId>C3A8413B-1F16-4DED-AC3E-61A00718DE8A</RequestId>
    <CreateTime>2019-10-15T08:17:14.000000</CreateTime>
    <StackGroupName>MyStackGroup</StackGroupName>
    <TemplateVersion>v1</TemplateVersion>
    <TemplateBody>{"ROSTemplateFormatVersion": "2015-09-01"}</TemplateBody>
    <ChangeSetId>e85abe0c-6528-43fb-ae93-fdf8de22****</ChangeSetId>
    <OwnerId>151266687691****</OwnerId>
    <UpdateTime>2019-10-15T08:17:14.000000</UpdateTime>
    <Permissions>
        <VersionOption>AllVersions</VersionOption>
        <AccountId>142437958638****</AccountId>
        <ShareOption>ShareToAccounts</ShareOption>
        <TemplateVersion>v1</TemplateVersion>
        <ShareSource>ROS</ShareSource>
    </Permissions>
    <TemplateName>MyTemplate</TemplateName>
    <RegionId>cn-hangzhou</RegionId>
    <TemplateId>4d4f5aa2-3260-4e47-863b-763fbb12****</TemplateId>
    <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
    <ShareType>Private</ShareType>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <Interface>{}</Interface>
    <Tags>
        <Key>usage</Key>
        <Value>test</Value>
    </Tags>
</ListTemplatesResponse>

JSON格式

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

{
  "TemplateARN" : "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description" : "ROS template for create ECS instance.",
  "RequestId" : "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "CreateTime" : "2019-10-15T08:17:14.000000",
  "StackGroupName" : "MyStackGroup",
  "TemplateVersion" : "v1",
  "TemplateBody" : "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetId" : "e85abe0c-6528-43fb-ae93-fdf8de22****",
  "OwnerId" : "151266687691****",
  "UpdateTime" : "2019-10-15T08:17:14.000000",
  "Permissions" : {
    "VersionOption" : "AllVersions",
    "AccountId" : "142437958638****",
    "ShareOption" : "ShareToAccounts",
    "TemplateVersion" : "v1",
    "ShareSource" : "ROS"
  },
  "TemplateName" : "MyTemplate",
  "RegionId" : "cn-hangzhou",
  "TemplateId" : "4d4f5aa2-3260-4e47-863b-763fbb12****",
  "StackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
  "ShareType" : "Private",
  "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
  "Interface" : "{}",
  "Tags" : [ {
    "Key" : "usage",
    "Value" : "test"
  } ]
}

错误码

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