Queries the details of a template based on stacks, stack groups, change sets, or any custom template information.
Operation description
In this example, the details of a template whose ID is 5ecd1e10-b0e9-4389-a565-e4c15efc****
is queried. The region ID of the template is cn-hangzhou
.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
StackId | string | No | The ID of the stack. Note
You must specify one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId.
| 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
RegionId | string | Yes | The region ID of the stack or stack group that uses the template. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
ChangeSetId | string | No | The ID of the change set. Note
You must specify one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId.
| 1f6521a4-05af-4975-afe9-bc4b45ad**** |
TemplateId | string | No | The ID of the template. This parameter applies to shared and private templates. If the template is a shared template, the value of TemplateId is the same as the value of TemplateARN. You can use the template ID to query a shared template. Note
You must specify one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId.
| 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateVersion | string | No | The version of the template. This parameter takes effect only if you specify TemplateId. Valid values: v1 to v100. | v1 |
TemplateStage | string | No | The stage of the template. This parameter takes effect only if you specify StackId, ChangeSetId, or StackGroupName. Valid values:
| Processed |
IncludePermission | string | No | Specifies whether to query the shared information about the template. Valid values:
Note
Only the template owner can query the shared information of a template.
| Enabled |
StackGroupName | string | No | The name of the stack group. Note
You must specify one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId.
| MyStackGroup |
IncludeTags | string | No | Specifies whether to query the information about tags. Valid values:
Note
This parameter takes effect only if you specify TemplateId.
| Enabled |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSON
format
{
"TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
"Description": "ROS template for create ECS instance.",
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84****",
"CreateTime": "2020-11-18T08:49:26",
"StackGroupName": "MyStackGroup",
"TemplateVersion": "v1",
"TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
"ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
"OwnerId": "151266687691****",
"UpdateTime": "2020-12-07T06:11:48",
"Permissions": [
{
"VersionOption": "AllVersions",
"AccountId": "142437958638****",
"ShareOption": "ShareToAccounts",
"TemplateVersion": "v1",
"ShareSource": "ROS"
}
],
"TemplateName": "MyTemplate",
"RegionId": "cn-hangzhou",
"TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\t",
"ShareType": "Private",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"Interface": "{}",
"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 |