GetTemplate - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries the information about a template, including the content of the template.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
oos:GetTemplate	get	template acs:oos:{#regionId}:{#accountId}:template/{#templateName}	oos:tag	none

Request syntax

POST /GetTemplate HTTP/1.1
GET /GetTemplate HTTP/1.1
POST /GetTemplate HTTP/1.1
GET /GetTemplate HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
TemplateName	string	Yes	The name of the template. The name can be 1 to 200 characters in length and can contain letters, digits, hyphens (-), and underscores (_). The name cannot start with ALIYUN, ACS, ALIBABA, or ALICLOUD.	MyTemplate
TemplateVersion	string	No	The version of the template. The default value is the latest version of the template.	v1

Response parameters

Parameter	Type	Description	Example
	object
Content	string	The content of the template.
RequestId	string	The request ID.	5BBE2663-A18E-5261-9BBB-F4832F5294D9
Template	object	The metadata of the template.
Hash	string	The SHA-256 value of the template content.	40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1
UpdatedDate	string	The time when the template was last updated.	2022-04-26T08:37:07Z
UpdatedBy	string	The user who last updated the template.	ACS
TemplateType	string	The type of the template.	Automation
Tags	object	The tag keys and values. The number of key-value pairs ranges from 1 to 20.	{"k1":"k2","k2":"v2"}
TemplateName	string	The name of the template.	ACS-ECS-CreateImage
TemplateVersion	string	The version of the template. The name of the version consists of the letter v and a number. The number starts from 1.	v15
TemplateFormat	string	The format of the template. The system automatically determines whether the format is JSON or YAML.	YAML
Description	string	The description of the template.
ResourceGroupId	string	The ID of the resource group.	rg-acfmxsn4m4******
CreatedBy	string	The creator of the template.	ACS
CreatedDate	string	The time when the template was created.	2019-05-16T10:26:14Z
VersionName	string	The name of the version of the template.	version15
TemplateId	string	The ID of the template.	t-4bdb1745c171401883a2
HasTrigger	boolean	Indicates whether the template was configured with a trigger.	false
ShareType	string	The share type of the template. The share type of a user-created template is Private.	Public

Examples

Sample success responses

JSONformat

{
  "Content": "",
  "RequestId": "5BBE2663-A18E-5261-9BBB-F4832F5294D9",
  "Template": {
    "Hash": "40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1",
    "UpdatedDate": "2022-04-26T08:37:07Z",
    "UpdatedBy": "ACS",
    "TemplateType": "Automation",
    "Tags": {
      "k1": "k2",
      "k2": "v2"
    },
    "TemplateName": "ACS-ECS-CreateImage",
    "TemplateVersion": "v15",
    "TemplateFormat": "YAML",
    "Description": "",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "ACS",
    "CreatedDate": "2019-05-16T10:26:14Z",
    "VersionName": "version15",
    "TemplateId": "t-4bdb1745c171401883a2",
    "HasTrigger": false,
    "ShareType": "Public"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-09	The internal configuration of the API is changed, but the call is not affected	View Change Details