{     "ZStackTemplateFormatVersion" : "YYYY-MM-DD",     "Description" : "模板描述信息，可用于说明模板的适用场景、架构说明等。",     "Parameters" : {       // 定义创建资源栈时，用户可以定制化的参数。     },     "Mappings" : {       // 定义映射信息表，映射信息是一种多层的Map结构。     },     "Resources" : {       // 所需资源的详细定义，包括资源间的依赖关系、配置细节等。     },     "Outputs" : {       // 用于输出一些资源属性等有用信息，可以通过API获取输出的内容。   }

• ZStackTemplateFormatVersion(必需)
  模板版本号。

  • 格式为：YYYY-MM-DD
• Description(可选)
  模板描述信息，可用于说明模板的适用场景、架构说明等。

  • 对模板进行详细描述，有利于用户理解模板内容。
• Parameters(可选)
  定义创建资源栈时，用户可以定制化的参数。

  • 例如，用户将创建云主机的计算规格设计成一个参数。
  • 参数支持默认值。
  • 使用参数可以增强模板的灵活性，提高复用性。
  • 关于参数(Parameters)的详细介绍，请参考参数(Parameters)章节。
• Mappings(可选)
  定义映射信息表，映射信息是一种多层的Map结构。

  • 可通过Fn::FindInMap函数选择key对应的值。
  • 可根据不同的输入参数值作为key查找映射表。
  • 例如，可根据区域不同，自动查找区域-镜像映射表，从而找到适用的镜像。
  • 关于映射(Mappings)的详细介绍，请参考映射(Mappings)章节。
• Resources(可选)
  所需资源的详细定义，包括资源间的依赖关系、配置细节等。

  • 关于资源(Resources)的详细介绍，请参考资源(Resources)章节。
• Outputs(可选)
  用于输出一些资源属性等有用信息，可以通过API获取输出的内容。

  • 关于输出(Outputs)的详细介绍，请参考输出(Outputs)章节。

• 参数名称必须为字母数字，同一个模板中不能与其它参数名称重复。
• 可以用Label字段定义友好的参数名。

• 常量参数可直接引用，无需在Parameters中定义（也不可定义）。
• 其值在资源编排运行时确定。

"Parameters" : {   "username" : {     "Label": "登录名",     "Description" : "登录名",     "DefaultValue": "root",     "Type" : "String"   },   "password" : {     "Label": "密码",     "NoEcho" : "true",     "Description" : "主机登录密码",     "Type" : "String",   } }

• username
  • 参数属于String类型，默认值为root。
  • 可指定的最小长度为2，可指定的最大长度为12。
  说明: username的默认值也必须符合长度限制和允许值限制。
• password
  • 参数属于String类型，无默认值。
  • 将NoEcho属性设置为true，可阻止查询栈接口返回参数值。
    说明: NoEcho属性设置暂不支持。
  • 可指定的最小长度为6，可指定的最大长度为41。
  • 允许大、小写字母字符和数字。

• 资源描述用大括号{ }括起。
• 如果声明多个资源，用逗号,分隔开。

"Resources" : {     "UUID-1" : {         "Description" : "资源描述",         "Type" : "资源类型",         "Properties" : {             资源属性描述         }     },     "UUID-2" : {         "Description" : "资源描述"         "Type" : "资源类型",         "Properties" : {             资源属性描述         }，         "DependsOn":"要依赖的资源，如UUID-1，注意上下文中必须包含此资源",         "DeletionPolicy":"删除策略"     } }

• 资源UUID
  • UUID-1、UUID-2均为资源逻辑UUID，且均为变量。
  • 在创建模板其它部分时，可以通过资源逻辑UUID引用该资源。
  • 资源逻辑UUID在模板中具有唯一性。
• 资源类型(Type)
  • 表示正在声明的资源的类型，包括：Resource类型、Action类型。
  • 例如，"Type": "ZStack::Resource::VmInstance"表示云主机实例，"Type": "ZStack::Action::AddIpRange"表示添加IP范围。
  • 关于资源编排支持的所有资源列表，详情请参考资源索引章节。
• 资源属性(Properties)
  • 为资源指定创建参数。
  • 代码段示例如下：

    "Resources" : {         "InstanceOffering" : {         "Type" : "ZStack::InstanceOffering",         "Properties" : {             "cpuNum" : "1",             "cpuSpeed" : "1",             "memorySize" : "1073741824",             "name" : "instance-offering",             "type" : "UserVm",             "sortKey": 0,             "allocatorStrategy": "LeastVmPreferredHostAllocatorStrategy"                }     } }

  • 资源属性值定义规则：
    • 属性值可以是文本字符串、字符串列表、布尔值、引用参数、或者函数返回值。
    • 如果属性值为文本字符串或布尔值，该值会被双引号" "括起来。
    • 如果属性值为任一类型的字符串列表，该值会被中括号[ ]括起来。
    • 如果值为内部函数或引用的参数，该值会被大括号{ }括起来。
    • 将文字、列表、引用参数、和函数返回值合并起来取值时，上述规则适用。
    • 以下示例说明如何声明不同的属性值类型：

      "Properties" : {     "String" : "string",     "LiteralList" : [ "value1", "value2" ],     "Boolean" : "true"     "ReferenceForOneValue" :  { "Ref" : "ResourceID" } ,     "FunctionResultWithFunctionParams" : {         "Fn::Join" : [ "%", [ "Key=", { "Ref" : "SomeParameter" } ] ] } }

  • 如果资源不需要声明任何属性，可以忽略该资源的属性部分。
• 资源依赖(DependsOn)
  • 定义资源所依赖的资源。
  • 为某个资源添加DependsOn属性后，该资源仅在DependsOn属性中指定的资源之后创建。
  • 代码段示例如下：

    {     "ZStackTemplateFormatVersion" : "2018-06-18",     "Resources" : {         "WebServer": {             "Type": "ZStack::Resource::VmInstance",             "DependsOn": "DatabseServer"         },         "DatabseServer": {             "Type": "ZStack::Resource::VmInstance",             "Properties": {                 "name": {"Fn::Join":["-",[{"Ref":"ZStack::StackName"},"VM"]]},                           "instanceOfferingUuid": {"Ref":"InstanceOfferingUuid"},                           "imageUuid":{"Ref":"ImageUuid"},                 "l3NetworkUuids":[{"Ref":"PrivateNetworkUuid"}],                 "dataDiskOfferingUuids":[{"Ref":"DiskOfferingUuid"}], 	         "hostUuid":{"Ref":"HostUuid"}             }         }     } }

    本例表示WebServer将在DatabaseServer创建成功后才开始创建。

• 删除策略(DeletionPolicy)
  • 在模板中，设置DeletionPolicy属性，可以声明资源栈被删除时是否保留资源。
  • DeletionPolicy有Retain和Delete两个选项。
    • 默认为Delete，表示删除资源栈默认会删除栈内编排创建的所有资源。
    • 若将DeletionPolicy设置为Retain，表示资源栈被删除时可保留资源。此时，该资源所依赖的资源也要保留（系统自动为其保留）。
      例如，模板对应的资源栈被删除时，保留栈内的云主机，代码段示例如下：

      "Resources" : {     "VMInstance" : {         "Type" : "ZStack::Resource::VmInstance",         "Properties": {             "name": {"Fn::Join":["-",[{"Ref":"ZStack::StackName"},"VM"]]},                       "instanceOfferingUuid": {"Ref":"InstanceOfferingUuid"},                       "imageUuid":{"Ref":"ImageUuid"},             "l3NetworkUuids":[{"Ref":"PrivateNetworkUuid"}],             "dataDiskOfferingUuids":[{"Ref":"DiskOfferingUuid"}], 	     "hostUuid":{"Ref":"HostUuid"}     },     "DeletionPolicy" : "Retain"   } }