ListTemplates - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries a list of private or shared templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:ListTemplates	get	Template acs:ros:{#regionId}:{#accountId}:template/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
TemplateName	string	No	The template name. This parameter takes effect only when ShareType is set to Private. The name can be up to 255 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). The name must start with a digit or letter.	MyTemplate
ShareType	string	No	The sharing type of the template. Valid values: Private (default): The template belongs to the template owner. Shared: The template is shared with other users. Official: The template is the shared template of the official version.	Private
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The key of the tag. This parameter takes effect only when ShareType is set to Private. You can specify up to 20 tag keys.	usage
Value	string	No	The value of the tag. This parameter takes effect only when ShareType is set to Private. You can specify up to 20 tag values.	deploy
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see the "Resource Group" section of What is Resource Management?	rg-acfmxazb4ph6aiy****
IncludeTags	string	No	Specifies whether to query the tag information. Valid values: Enabled Disabled (default)	Enabled

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of templates.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumber	integer	The page number. Pages start from page 1.	1
Templates	array<object>	The templates.
	object	The template.
TemplateARN	string	The Alibaba Cloud Resource Name (ARN) of the template.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
UpdateTime	string	The time when the template was last updated.	2019-10-15T08:17:14.000000
Description	string	The description of the template.	test-description
CreateTime	string	The time when the template was created.	2019-10-15T08:17:14.000000
TemplateName	string	The template name.	demo
TemplateVersion	string	The latest version of the template.	v1
TemplateId	string	The template ID.	4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerId	string	The ID of the Alibaba Cloud account to which the template belongs.	151266687691****
ShareType	string	The sharing type of the template. Valid values: Private: The template belongs to the template owner. Shared: The template is shared with other users.	Private
ResourceGroupId	string	The ID of the resource group.	rg-acfmxazb4ph6aiy****
Tags	array<object>	The tags of the template.
	object	The tag of the template.
Key	string	The key of the tag.	usage
Value	string	The value of the tag.	test

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-06-09	The request parameters of the API has changed. The response structure of the API has changed	View Change Details