ValidateTemplateContent - CloudOps Orchestration Service

Check whether a template is valid.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
Content	string	Yes	The content of the template.	{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}
TemplateURL	string	No	The URL that is used to store the content of the Operation Orchestration Service (OOS) template in the Alibaba Cloud Object Storage Service (OSS). Only the public-read URL is supported. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.	http:/oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-template.json

Response parameters

Parameter	Type	Description	Example
	object
Outputs	string	The outputs of the template.	{}
RequestId	string	The ID of the request.	D5EE9591-1F2D-573E-8751-7F08BBB388D4
Parameters	string	The parameters of the template.	{ "Status": { "Description": "(Required) The status of the Ecs instance.", "Type": "String" } }
RamRole	string	The RAM role.	OOSServiceRole
Tasks	array<object>	The task defined in the template.
Task	object
Outputs	string	The outputs of the task.	.instanceId
Type	string	The type of the task.	ACS::ExecuteAPI
Description	string	The description of the task.	(Required) The status of the Ecs instance.
Name	string	The name of the task.	foo
Properties	string	The properties of the task.	{"API": "DescribeInstances","Parameters": {"Status": "{{ Status }}"},"Service": "Ecs"}

Examples

Sample success responses

JSONformat

{
  "Outputs": "{}",
  "RequestId": "D5EE9591-1F2D-573E-8751-7F08BBB388D4",
  "Parameters": "{ \"Status\": { \"Description\": \"(Required) The status of the Ecs instance.\", \"Type\": \"String\" } }",
  "RamRole": "OOSServiceRole",
  "Tasks": [
    {
      "Outputs": ".instanceId",
      "Type": "ACS::ExecuteAPI",
      "Description": "(Required) The status of the Ecs instance.",
      "Name": "foo",
      "Properties": "{\"API\": \"DescribeInstances\",\"Parameters\": {\"Status\": \"{{ Status }}\"},\"Service\": \"Ecs\"}"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-11-07	The request parameters of the API has changed	View Change Details