ValidateTemplateContent - CloudOps Orchestration Service

Validates the syntax of a template.

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

oos:ValidateTemplateContent

get

*All Resource

*

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Content	string	No	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 of the OOS template in Object Storage Service (OSS). Only public-read URLs are supported. This parameter lets you create an execution from the template content stored at the URL without having to create a template first. Do not specify this parameter if you create an execution from an existing template.	http:/oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-template.json

Response elements

Element	Type	Description	Example
	object
Outputs	string	The outputs of the template.	{}
RequestId	string	The request ID.	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 tasks defined in the template.
	object
Outputs	string	The outputs of the task.	.instanceId
Type	string	The action type.	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.