ListTemplates - Logic Composer - Alibaba Cloud Documentation Center

Lists the templates visible to the current user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

composer:ListTemplates

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100 and the default value is 10.	10
Name	string	No	The keyword used to search for templates. This parameter does not take effect if the Tag parameter is specified.	test
Tag	string	No	The tag used to filter templates.	财务管理
Lang	string	No	The language of the template. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of templates.	10
RequestId	string	The ID of the request.	ADB97A33-50E7-48A5-963D-ACBAE36D0BEC
Templates	array<object>	The list of templates.
	object	The information about the template.
UpdateTime	string	The time when the template was last updated.	2020-08-19T03:31:32.415Z
TemplateOverview	string	An overview of the template, which is a JSON string.	[]
TemplateConnector	string	A list of connectors that are used in the template. Multiple connectors are separated by commas (,).	oss,rds
CreateTime	string	The time when the template was created.	2020-08-19T03:31:32.415Z
TemplateSummaryEn	string	The English summary of the template.	This is a test template
TemplateName	string	The name of the template.	测试模板
TemplateVersion	integer	The version of the template. The value is a number that increments from 0.	0
TemplateLocale	string	The language of the template. Chinese (zh) and English (en) are supported.	zh
TemplateCreator	string	The publisher of the template.	逻辑编排
TemplateDescription	string	The description of the template.	这是一个测试用的模板
TemplateTag	string	The tag of the template.	finance
TemplateSummary	string	A brief introduction to the template.	测试模板的简介
TemplateId	string	The ID of the template.	tp-uf6tbvhheciyxl

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "ADB97A33-50E7-48A5-963D-ACBAE36D0BEC",
  "Templates": [
    {
      "UpdateTime": "2020-08-19T03:31:32.415Z",
      "TemplateOverview": "[]",
      "TemplateConnector": "oss,rds",
      "CreateTime": "2020-08-19T03:31:32.415Z",
      "TemplateSummaryEn": "This is a test template",
      "TemplateName": "测试模板",
      "TemplateVersion": 0,
      "TemplateLocale": "zh",
      "TemplateCreator": "逻辑编排",
      "TemplateDescription": "这是一个测试用的模板",
      "TemplateTag": "finance",
      "TemplateSummary": "测试模板的简介",
      "TemplateId": "tp-uf6tbvhheciyxl"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.