GetResourceTypeTemplate - Resource Orchestration Service

Generates a sample template based on a resource type.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
ros:GetResourceTypeTemplate	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type.	ALIYUN::ECS::VPC
VersionId	string	No	The version ID. If you want to query a specific version of the resource type, you must specify this parameter. If you do not specify this parameter, only the resource type is queried. Note This parameter is supported only for modules.	v1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	87F54B2B-AEF0-4C33-A72A-3F8856A575E9
TemplateBody	object	The structure that contains the template body. The template body must be 1 to 51,200 bytes in length. For more information, see Template syntax. Note We recommend that use TemplateContent instead of TemplateBody.	{"ROSTemplateFormatVersion": "2015-09-01"}
TemplateContent	string	The JSON-formatted structure of the template body. For more information, see Template syntax.	{ "ROSTemplateFormatVersion": "2015-09-01" }

The structure that contains the template body.

The template body must be 1 to 51,200 bytes in length.

For more information, see Template syntax.

Examples

Sample success responses

JSONformat

{
  "RequestId": "87F54B2B-AEF0-4C33-A72A-3F8856A575E9",
  "TemplateBody": {
    "ROSTemplateFormatVersion": "2015-09-01"
  },
  "TemplateContent": "{\n      \"ROSTemplateFormatVersion\": \"2015-09-01\"\n}"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-10	The request parameters of the API has changed. The response structure of the API has changed	View Change Details