Use GetTemplateSummary to query template information - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Queries the information about a template resource by using the relevant template, stack, stack group, or change set.

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

ros:GetTemplateSummary

get

Stack

acs:ros:{#regionId}:{#accountId}:stack/{#StackId}

None

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	No	The stack ID. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	No	The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body exceeds the upper limit, we recommend that you add parameters to the HTTP POST request body to prevent request failures caused by excessively long URLs. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName.	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	No	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. This parameter takes effect only when one of the following parameters are specified: StackId, ChangeSetId, and StackGroupName.	cn-hangzhou
TemplateId	string	No	The template ID. This parameter applies to shared and private templates. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	No	The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in an Object Storage Service (OSS) bucket, such as oss://ros/template/demo or oss://ros/template/demo?RegionId=cn-hangzhou. The template body can be up to 524,288 bytes in length. Note If you do not specify the region ID of the OSS bucket, the value of RegionId is used. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName. The URL can be up to 1,024 bytes in length.	oss://ros/template/demo
ChangeSetId	string	No	The ID of the change set. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	No	The version of the template. This parameter takes effect when TemplateId is specified.	v1
StackGroupName	string	No	The name of the stack group. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and StackGroupName.	my-stack-group
Parameters	array<object>	No	The parameters that are defined in the template.
	object	No
ParameterKey	string	No	The name of parameter N that is defined in the template. If you do not specify the name and value of a parameter, Resource Orchestration Service (ROS) uses the default name and value that are defined in the template. Maximum value of N: 200. Note The Parameters parameter is optional. If you specify Parameters, you must specify both Parameters.N.ParameterKey and Parameters.N.ParameterValue.	InstanceId
ParameterValue	string	No	The value of parameter N that is defined in the template. Maximum value of N: 200. Note The Parameters parameter is optional. If you specify Parameters, you must specify both Parameters.N.ParameterKey and Parameters.N.ParameterValue.	i-rotp2e20whfrs2****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). For more information, see Ensure idempotence.	123e4567-e89b-12d3-a456-42665544****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
ResourceTypes	array	All resource types that are used in the template.
	string	The resource type that is used in the template.	["ALIYUN::ECS::VPC"]
Description	string	The description of the stack template.	No description
Parameters	array<object>	The declarations of the parameters in the template.
	object	The declaration of the parameter in the template.	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	The request ID.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	The version of the template.	2015-09-01
Metadata	object	The metadata that is defined in the template.	{"key": "value"}
ResourceIdentifierSummaries	array<object>	The resource identifier summaries. A summary describes the resource that you want to import and the properties that are used to identify the resource during the import. For example, VpcId is an identifier property of ALIYUN::ECS::VPC.
	object
ResourceType	string	The resource type. Note The resource import feature is supported for the resource type.	ALIYUN::ECS::VPC
LogicalResourceIds	array	The logical IDs of all resources of the type that is specified by ResouceType in the template.
	string	The logical ID of the resource of the type that is specified by ResouceType in the template.	["Vpc"]
ResourceIdentifiers	array	The resource properties. You can use a resource property to identify the resource that you want to manage. For example, VpcId is an identifier property of ALIYUN::ECS::VPC.
	string	The resource property. You can use a resource property to identify the resource that you want to manage. For example, VpcId is an identifier property of ALIYUN::ECS::VPC.	["VpcId"]

Examples

Success response

JSON format

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.