华为云首页用户手册

资源编排服务 RFS-创建执行计划:请求参数

资源编排服务 RFS-创建执行计划:请求参数

时间：2024-12-12 20:29:55

资源编排服务 RFS

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Client-Request-Id	是	String	用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

表3 请求Body参数
参数	是否必选	参数类型	描述
stack_id	否	String	资源栈（stack）的唯一Id。此Id由资源编排服务在生成资源栈的时候生成，为UUID。由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400
template_body	否	String	HCL模板，描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在在CreateStack API中，template_body和template_uri可以都不给予注意： template_body中默认不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的template_body。如为敏感信息，建议将敏感信息通过vars_structure参数化，并设置encryption字段开启加密
template_uri	否	String	HCL模板的OBS地址，该模板描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。请确保OBS地址所在局点与使用 RFS 服务局点一致。对应的文件应该是纯tf文件或zip压缩包纯tf文件需要以.tf或者.tf.json结尾，并遵守HCL语法压缩包目前只支持zip格式，文件需要以.zip结尾。解压后的文件不得包含".tfvars"文件且必须是UTF8编码（其中.tf.json不能包含BOM头），zip压缩包当前支持的子文件数量最大为100 template_body和template_uri 必须有且只有一个存在在CreateStack API中，template_body和template_uri可以都不给予注意： template_uri对应的模板文件中默认不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的模板文件内容。如为敏感信息，建议将敏感信息通过vars_structure参数化，并设置encryption字段开启加密 template_uri对应的模板文件如果为zip类型，则内部的文件或文件夹名称长度不得超过255个字节，最深路径长度不得超过2048字节，zip包大小不得超过1MB
execution_plan_name	是	String	执行计划的名称。此名字在domain_id+区域+project_id+stack_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。
description	否	String	执行计划的描述。可用于客户识别自己的执行计划。
vars_structure	否	Array of VarsStructure objects	HCL参数结构。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 var_structure可以允许客户提交最简单的字符串类型的参数资源编排服务支持vars_structure，vars_body和vars_uri，如果以上三种方式中声明了同一个变量，将报错400 vars_structure中的值只支持简单的字符串类型，如果需要使用其他类型，需要用户自己在HCL引用时转换，或者用户可以使用vars_uri、vars_body，vars_uri和vars_body中支持HCL支持的各种类型以及复杂结构如果vars_structure过大，可以使用vars_uri 注意：vars_structure中默认不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的vars。如为敏感信息，建议设置encryption字段开启加密
vars_body	否	String	HCL参数文件的内容。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 vars_body使用HCL的tfvars格式，用户可以将“.tfvars”中的内容提交到vars_body中。资源编排服务支持vars_structure，vars_body和vars_uri，如果以上三种方式中声明了同一个变量，将报错400 如果vars_body过大，可以使用vars_uri 如果vars中都是简单的字符串格式，可以使用var_structure 注意：vars_body中不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的vars。如为敏感信息，建议通过vars_structure并设置encryption字段传递
vars_uri	否	String	HCL参数文件的OBS地址。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。请确保OBS地址所在局点与使用RFS服务局点一致。资源编排服务支持vars_structure，vars_body和vars_uri，如果以上三种方式中声明了同一个变量，将报错400 vars_uri中的内容使用HCL的tfvars格式，用户可以将“.tfvars”中的内容保存到文件并上传到OBS中，并将OBS pre-signed URL传递给vars_uri。注意：vars_uri的内容不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的vars。如为敏感信息，建议通过vars_structure并设置encryption字段传递

表4 VarsStructure
参数	是否必选	参数类型	描述
var_key	是	String	参数的名字
var_value	是	String	参数的值。注意，参数需要以字符串形式存在，如果是数字，也需要以字符串形式存在，如'10'。如果需要支持不同类型，或者复杂结构，请使用vars_uri或vars_body
encryption	否	EncryptionStructure object	如果用户传递的var_value是已经加密过的，可以通过声明此项以要求资源编排服务在使用前进行解密，目前暂时只支持KMS加解密

表5 EncryptionStructure
参数	是否必选	参数类型	描述
kms	是	KmsStructure object	如果用户给予的var_value是经过KMS加密的，可以通过传递相关加密信息，资源编排服务在使用的时候会帮助用户进行KMS解密更多关于KMS加密以及KMS加密的样例代码请见：KMS加密使用场景介绍注意：请确保用户给予资源编排服务的委托中包含对指定密钥ID的操作权限 KMS每个月有免费试用的额度，如果超过，则KMS需要收费，此费用不是资源编排服务收取，具体标准见：https://www.huaweicloud.com/pricing.html?tab=detail#/dew KMS加密只代表资源编排服务在存储和传输的时候传递的是密文，但是在stack-events中依然是明文，如果希望在log中以密文形式对待，请在模板中声明sensitive，更多关于sensitive的介绍见：https://learn.hashicorp.com/tutorials/terraform/sensitive-variables

表6 KmsStructure
参数	是否必选	参数类型	描述
id	是	String	解密时，资源编排服务应该使用的KMS密钥的ID，通常是加密时所使用的密钥ID
cipher_text	是	String	数据加密密钥所对应的密文

上一篇：资源编排服务 RFS-创建执行计划:响应参数

下一篇：资源编排服务 RFS-创建执行计划:响应参数

新客秒杀 2核2G 3M L实例

68元/年

普惠上云领千元上云礼券

立即前往

企业专享 X实例 4核8G 5M

888元/年

热门域名 1元随心购

1元/年起

资源编排服务 RFS-创建执行计划:请求参数

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题