All Products
Document Center

Template structure

Last Updated: Sep 02, 2019

The content of a template is a piece of UTF-8 text in the JSON or YAML format. The template defines the version, parameters, tasks, sequence, inputs, and outputs. You can use the template to define the required O&M operations.


  • YAML format
  1. ---
  2. FormatVersion: OOS-2019-06-01 # Required. The version of the template. Example: OOS-2019-06-01.
  3. Description: "" # Optional. The description of the template, such as the features or usage of the template.
  4. Parameters: # Optional. The parameters to be set for executing the template. For more information, see the relevant documentation.
  5. RamRole: # Optional. The role that Operation Orchestration Service (OOS) assumes to call the API operations of each cloud product. Default value: OOSServiceRole.
  6. 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.
  7. 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.)
  1. {
  2. "FormatVersion": "OOS-2019-06-01",
  3. "Description": "",
  4. "Parameters": {},
  5. "RamRole": "",
  6. "Tasks": [],
  7. "Outputs": {}
  8. }