All Products
Search
Document Center

CloudOps Orchestration Service:Template structure

Last Updated:Jun 16, 2026

An OOS template is a UTF-8 encoded JSON or YAML document that defines the version, parameters, tasks, sequence, inputs, and outputs for O&M operations.

A template is UTF-8 text in JSON or YAML format. It defines the version, parameters, tasks, sequence, inputs, and outputs for O&M operations.

Syntax

  • YAML format
---
FormatVersion: OOS-2019-06-01 # Required. The version of the template. Example: OOS-2019-06-01.
Description: "" # Optional. The description of the template, such as the features or usage of the template.
Parameters: # Optional. The parameters to be set for executing the template. For more information, see the relevant documentation.
RamRole: # Optional. The role that Operation Orchestration Service (OOS) assumes to call the API operations of each cloud product. Default value: OOSServiceRole.
Tasks: # Required. The tasks to be executed. As the most important component of a template, the Tasks parameter defines the details of O&M operations. Each task in the template corresponds to an action. By default, multiple tasks are executed one by one. If a task is a loop task, concurrent child execution may occur within the task. For more information, see the relevant documentation.
Outputs: # Optional. The template outputs, such as resource attributes. You can obtain the outputs through the API or the OOS console. For more information, see the relevant documentation.
  • JSON format (For more information, see the parameter description for the YAML format.)
{
  "FormatVersion": "OOS-2019-06-01",
  "Description": "",
  "Parameters": {},
  "RamRole": "",
  "Tasks": [],
  "Outputs": {}
}