文档中心

云服务器

请输入

附录

自定义模板语法说明

模板语法用于定义模板结构，包括参数、执行顺序、输入和输出等字段约束及校验规则等，火山引擎支持通过JSON格式定义自定义模板，支持的结构如下：

参数	说明
FormatVersion	可选，引擎版本，默认为0.2。
Description	可选，描述，可用于说明模版的用途、目的等。
Parameters（参数）	可选，Parameters用于定义模板执行过程中所使用的参数列表，了解更多。
Tasks（任务）	必选，Tasks是模板最重要的组成部分，每一个Task定义了一个具体的执行动作，动作由运维编排定义和实现，了解更多。说明若为多个任务，默认按照从上到下的顺序依次串行执行。若某个任务是一个循环（Loop）任务，则在该任务内部可能出现并发的子执行。
Outputs（输出）	可选，Outputs用于定义模板执行后输出的关键数据，可引用任务（指定任务名称）的输出，了解更多。

Parameters（参数）说明

Parameters用于定义模板执行过程中所使用的参数列表，包括参数名称、参数类型、默认值。

说明

若未声明默认值，则默认是参数类型的零值（即该类型的默认初始值）。

Tasks（任务）说明

Tasks是模板最重要的组成部分，每一个Task定义了一个具体的执行动作，动作由运维编排定义和实现，包括原子性动作和云产品动作。了解更多。

说明

Tasks结构

参数	是否必填	说明
Name	是	任务名称，取值：仅支持字母、数字、中划线（-）和下划线（_）。长度限制为1 ~ 200个字符。
Description	否	描述信息，描述当前任务的用途。
Action	是	动作的名称。
Timeout	否	可选，超时时间，最长600s。
Parameters	否	当前Task执行时需要的参数集合，可通过JQ表达获取值。需要的参数由Action确定，具体参考动作章节。
Outputs	否	当前任务的输出定义，可以用作后续任务的输入或模板的输出。了解更多。 Type：字段类型。 Value：字段值。
Loop	否	任务循环，详情请参见循环任务（Loop）。
OnError/OnSuccess	否	任务执行结果为失败或成功时，指定后续的操作。取值： OnError：用于定义任务执行失败时的行为，当为： VOS::END（默认）：终止整个执行。 VOS::Next：继续执行下一个任务 OnSuccess：用于定义任务执行成功时的行为，当为： VOS::END：终止整个执行。 VOS::Next（默认）：执行下一个任务。

循环任务（Loop）

火山引擎为Task提供特殊属性“循环任务”，基于LoopItem给定的Item列表，可自动生成批量任务执行，并支持配置执行批次、并发度等参数，实现规模化任务调度。

说明

VOS::LoopItem：是一个内置变量，用于表示参数取值来源于“Loop”字段定义的循环项，例如 {{ .InstanceIds }} 中的每个元素会通过此变量依次获取。

使用限制

Loop Items的个数限制当前最大为1000个。

语法结构

参数说明

Outputs说明

Outputs（输出）用于获取模板执行后的关键数据，确保使用者能准确获取所需的结果（如实例操作后的状态、任务 ID、执行时间等）。

示例如下：

最近更新时间：2025.10.14 19:51:05

这个页面对您有帮助吗？

有用

无用