模板参数

最近更新时间:2025-01-13 15:46:22

我的收藏

参数定义

模板参数定义包括了参数名、参数描述、参数类型及默认值。
Parameters:
# 参数名
ParameterName:
# [选填] 参数描述
Description: 参数描述
# [选填] 参数类型,当前支持 Number / String / Boolean / JSON,默认为 String
Type: String
# [选填] 默认值
Default: abc

内置参数

除用户参数外,模板提供了内置参数以获取执行环境相关信息。内置参数无需定义可直接使用,当前支持的内置参数如下:
Cloudapp
参数类型
参数描述
JSON
当前执行模板的云应用实例相关信息,包括基础信息及资源信息。其中资源信息仿造应用包 Terraform 中定义描述,各类资源可获取到的具体属性值可参考云应用 资源类型手册
示例如下:
{
"CloudappId": "cloudapp-abcdefgh",
"PackageId": "pkg-abcdefgh",
"Terraform": {
"resource": {
"tencentcloud_instance": {
"main_cvm": {
"id": "ins-abcdefgh",
"region": "ap-guangzhou",
"availability_zone": "ap-guangzhou-7",
"vpc_id": "vpc-abcdefgh",
"...": "..."
}
}
},
"output": {}
}
}

参数引用

参数可以在任务模板输出中引用,语法如下:
直接使用
说明:
直接使用时,虽然语法使用了字符串形式,但执行中引用值类型会被原样解析。
"{{ .ParameterName }}"
"{{ .ParameterName.List[0].State }}"
在字符串中引用
"Hi, {{ .ParameterA }} and {{ .ParameterB }}"
其中,引用值的获取使用了 jq 处理,详细用法可参见 jq 相关介绍