模板语法的元数据 - 资源编排

元数据（Metadata）不仅支持对Parameters中定义的参数进行分组，还支持对自定义参数进行隐藏，您可以在资源编排控制台的配置参数页面查看效果。

语法

Metadata:
  ALIYUN::ROS::Interface:
    # ParameterGroups为必填项
    ParameterGroups:
      - <ParameterGroup1>
      - <ParameterGroup2>
      - ...

ParameterGroup语法

# Parameters为必填项
Parameters: 
    - <Parameter1>
    - <Parameter2>
    - ...
# Label为必填项
Label: 
    default: <自定义字符串>

参数分组示例

您可以对Parameters中定义的参数进行分组，并且为每一组分别定义标签。

ROSTemplateFormatVersion: '2015-09-01'
Description: Metadata演示
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcName
          - VpcCidrBlock
        Label:
          default: VPC
      - Parameters:
          - VswName
          - VswCidrBlock
        Label:
          default: VSwitch
Parameters:
  VpcName:
    Type: String
    Label: 名称
    Description: 长度为2~128个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、下划线（_）和短划线（-）。
    Default: MyVPC
  VswName:
    Type: String
    Label: 名称
    Description: 长度为2~128个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、下划线（_）和短划线（-）。
    Default: MyVSwitch
  VpcCidrBlock:
    Type: String
    AllowedValues:
      - 10.0.0.0/8
      - 172.16.0.0/12
      - 192.168.0.0/16
    Description: 专有网络网段。如需自定义网段，请更改模板此参数的可用值，网段必须属于可用值范围的子网网段。
    Label: IPv4网段
    Default: 192.168.0.0/16
  VswCidrBlock:
    Type: String
    Description: 必须是所属专有网络的子网段，并且没有被其他交换机占用。
    Label: IPv4网段
    Default: 192.168.1.0/24
Resources:
  VSwitch:
    Type: ALIYUN::ECS::VSwitch
    Properties:
      VpcId:
        Ref: VPC
      ZoneId:
        Fn::Select:
          - '1'
          - Fn::GetAZs:
              Ref: ALIYUN::Region
      CidrBlock:
        Ref: VswCidrBlock
      VSwitchName:
        Ref: VswName
  VPC:
    Type: ALIYUN::ECS::VPC
    Properties:
      CidrBlock:
        Ref: VpcCidrBlock
      VpcName:
        Ref: VpcName

参数隐藏示例

您可以对自定义参数进行隐藏参数，以达到在资源编排控制台页面中不展示特定参数信息的目的。

ROSTemplateFormatVersion: '2015-09-01'
Description: Metadata演示
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcName
        Label:
          default: VPC
      - Parameters:
          - VswName
        Label:
          default: VSwitch
    # 在Hidden属性内添加的参数信息在控制台页面中会被隐藏
    Hidden:
      - VpcCidrBlock
      - VswCidrBlock
Parameters:
  VpcName:
    Type: String
    Label: 名称
    Description: 长度为2~128个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、下划线（_）和短划线（-）。
    Default: MyVPC
  VswName:
    Type: String
    Label: 名称
    Description: 长度为2~128个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、下划线（_）和短划线（-）。
    Default: MyVSwitch
  VpcCidrBlock:
    Type: String
    AllowedValues:
      - 10.0.0.0/8
      - 172.16.0.0/12
      - 192.168.0.0/16
    Description: 专有网络网段。如需自定义网段，请更改模板此参数的可用值，网段必须属于可用值范围的子网网段。
    Label: IPv4网段
    Default: 192.168.0.0/16
  VswCidrBlock:
    Type: String
    Description: 必须是所属专有网络的子网段，并且没有被其他交换机占用。
    Label: IPv4网段
    Default: 192.168.1.0/24
Resources:
  VSwitch:
    Type: ALIYUN::ECS::VSwitch
    Properties:
      VpcId:
        Ref: VPC
      ZoneId:
        Fn::Select:
          - '1'
          - Fn::GetAZs:
              Ref: ALIYUN::Region
      CidrBlock:
        Ref: VswCidrBlock
      VSwitchName:
        Ref: VswName
  VPC:
    Type: ALIYUN::ECS::VPC
    Properties:
      CidrBlock:
        Ref: VpcCidrBlock
      VpcName:
        Ref: VpcName