GetTemplate - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

Retrieves information about the template image and architecture diagram.

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:GetTemplate

get

*Template

acs:bpstudio::{#accountId}:template/{#TemplateId}

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The ID of the template.	XFKR6WYRVS24S07R
Region	string	No	The region of the template.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzhfgmw4e6fwq

Response elements

Element	Type	Description	Example
	object
Message	string	The error message.	Success
RequestId	string	The ID of the request.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	object	The details of the template.
Description	string	The description of the template.
ImageURL	string	The path of the template's architecture diagram file.	bp-studio-template/sr-U37UD2YQCRJ75X5V.png
Name	string	The name of the template.	cadt-template
TemplateId	string	The ID of the template.	XFKR6WYRVS24S07R
CreateTime	string	The time when the template was created.	2020-09-22 17:08:31
ResourceGroupId	string	The ID of the resource group.	rg-aekzhfgmw4e6fwq
Variables	array<object>	The details of the template variables.
	object
Attribute	string	The name of the variable.	instance_name
DataType	string	The type of the variable.	String
DefaultValue	string	The default value.	cadt-app-01
Variable	string	The value of the variable.	${name}
Options	string
DocumentUrl	string	The details of the scenario.
Code	string	The return code.	200

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "Description": "",
    "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
    "Name": "cadt-template",
    "TemplateId": "XFKR6WYRVS24S07R",
    "CreateTime": "2020-09-22 17:08:31",
    "ResourceGroupId": "rg-aekzhfgmw4e6fwq",
    "Variables": [
      {
        "Attribute": "instance_name",
        "DataType": "String",
        "DefaultValue": "cadt-app-01",
        "Variable": "${name}",
        "Options": ""
      }
    ],
    "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.ResourceGroup	The resource group does not exist.
404	EntityNotExist.ResourceId	The resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.