Use ValidateTemplateContent to validate template syntax - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Validates whether a template is valid.

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 template content.	{"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 stored in Alibaba Cloud Object Storage Service (OSS). Only URLs with public-read permission are supported. You can specify this parameter to directly create a task execution based on the template content stored at the TemplateURL, without creating a template first. This parameter is not required if you select an existing template to create a task execution.	http:/oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-template.json

Response elements

Element	Type	Description	Example
	object
Outputs	string	The template outputs.	{}
RequestId	string	The request ID.	D5EE9591-1F2D-573E-8751-7F08BBB388D4
Parameters	string	The template parameters.	{ "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 task outputs.	.instanceId
Type	string	The action type.	ACS::ExecuteAPI
Description	string	The task description.	(Required) The status of the Ecs instance.
Name	string	The task name.	foo
Properties	string	The task properties.	{"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.