ZStack Logo

ZStack AIOS

参数(Parameters)

完整平台用户手册,包含基础云平台能力与 AIOS 相关章节。

参数(Parameters):定义创建资源栈时,用户可以定制化的参数。
  • 创建资源栈模板时,使用参数可以增强模板的灵活性,提高复用性。
  • 创建资源栈时,可根据实际情况替换模板中的某些参数值。

语法

参数由参数名称和参数属性组成。
  • 参数名称必须为字母数字,同一个模板中不能与其它参数名称重复。
  • 可以用Label字段定义友好的参数名。
参数属性列表:
属性 描述 是否必需 举例
Type 参数类型,默认支持:
  • String
  • Number(整数或浮点)
  • CommaDelimitedList(相当于Java里的List<String>)
  • Boolean
"Type": "String"
Lable 参数别名,生成预览或正式表单时用 "Lable": "云主机密码"
Description 参数描述 "Description": "云主机登录密码"
NoEcho 该字段是否用*****替代,不填则不替代 "NoEcho": true
说明: 暂不支持
DefaultValue 参数默认值 "DefaultValue": "password"
资源编排还提供一些常量参数。
  • 常量参数可直接引用,无需在Parameters中定义(也不可定义)。
  • 其值在资源编排运行时确定。
常量参数列表
常量名 描述
ZStack::StackName 当前栈的名称
ZStack::StackUuid 当前栈的UUID
ZStack::AccountUuid 当前栈的AccountUuid
ZStack::AccountName 当前栈的AccountName

示例

代码段示例如下:
"Parameters" : {
  "username" : {
    "Label": "登录名",
    "Description" : "登录名",
    "DefaultValue": "root",
    "Type" : "String"
  },
  "password" : {
    "Label": "密码",
    "NoEcho" : "true",
    "Description" : "主机登录密码",
    "Type" : "String",
  }
}
本例中Parameters声明两个参数:
  • username
    • 参数属于String类型,默认值为root
    • 可指定的最小长度为2,可指定的最大长度为12
    说明: username的默认值也必须符合长度限制和允许值限制。
  • password
    • 参数属于String类型,无默认值。
    • NoEcho属性设置为true,可阻止查询栈接口返回参数值。
      说明: NoEcho属性设置暂不支持。
    • 可指定的最小长度为6,可指定的最大长度为41
    • 允许大、小写字母字符和数字。