ListTemplate - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

Retrieves a list of templates, including their names, architecture diagram URLs, and serialized architecture diagram file URLs.

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

bpstudio:ListTemplate

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	integer	Yes	The page number.	1
MaxResults	integer	Yes	The number of entries per page.	10
OrderType	integer	No	The field to sort by: 1: Sort by update time. 2: Sort by creation time. 3: Sort by system recommendation. 4: Sort by usage count. If you do not specify this parameter or specify an integer other than 1, 2, 3, or 4, the results are sorted by system recommendation.	1
Keyword	string	No	A keyword for searching template names.	“CADT”
Type	string	Yes	public indicates a public template. private indicates a private template.	private
TagList `deprecated`	integer	No	The tags of the template.	2
ResourceGroupId	string	No	The resource group ID.	rg-acfmyjt3c5om3hi
Tag	array<object>	No	The list of tags.
	object	No	Tag information.
Key	string	No	The tag key.	tag
Value	string	No	The tag value.	value

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	100
Message	string	The error message.	Success
NextToken	integer	The page number.	1
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	array<object>	The list of templates.
	array<object>
ImageURL	string	The image URL of the template.	bp-studio-template/sr-U37UD2YQCRJ75X5V.png
TagId `deprecated`	integer	The ID of the template's tag.	1
TagName `deprecated`	string	The name of the template's tag.	TagName
Name	string	The name of the template.	cadt-name
TemplateId	string	The ID of the template.	CJQ6H0XUEQ20IYJQ
CreateTime	string	The creation time.	2021-03-18 16:41:31
ResourceGroupId	string	The resource group ID.	rg-acfmyjt3c5om3hi
Tag	array<object>	The list of tags.
	object	Tag information.
Key	string	The tag key.	tag1
Value	string	The tag value.	value1
Description	string	The description of the template.
DocumentUrl	string	The scenario details.
Code	string	The status code.	200

Examples

Success response

JSON format

{
  "TotalCount": 100,
  "Message": "Success",
  "NextToken": 1,
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": [
    {
      "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
      "TagId": 1,
      "TagName": "TagName",
      "Name": "cadt-name",
      "TemplateId": "CJQ6H0XUEQ20IYJQ",
      "CreateTime": "2021-03-18 16:41:31",
      "ResourceGroupId": "rg-acfmyjt3c5om3hi",
      "Tag": [
        {
          "Key": "tag1",
          "Value": "value1"
        }
      ],
      "Description": "",
      "DocumentUrl": ""
    }
  ],
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.	You must specify request parameters.
500	ServiceError	A server error occurred. Please try again later.
404	EntityNotExist.ResourceId	The resource does not exist.
404	EntityNotExist.ResourceGroup	The resource group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.