# 资源编排服务 RFS > 批量自动化创建云服务资源 ## 产品介绍 - [产品功能](https://support.huaweicloud.com/productdesc-aos/rf_01_0001.md): 本页面介绍了RFS服务支持的主要功能。资源栈资源栈是云服务资源的集合。资源栈将模板描述的所有云服务资源作为一个整体来进行创建、删除、更新、查询等。模板模板是一个HCL语法文本描述文件,支持tf、tf.json、zip包文件格式,用于描述您的云资源。资源编排根据模板完成各种云资源的创建。 - [基本概念](https://support.huaweicloud.com/productdesc-aos/rf_02_0001.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [什么是资源编排](https://support.huaweicloud.com/productdesc-aos/rf_02_0002.md): 资源编排是完全支持业界事实标准Terraform(HCL + Provider)的终态编排引擎,用于管理系统资源及服务资源(一切可定位、描述的物理或者逻辑实体,例如数据库,VPC,流水线,IAM中的Role)。资源编排采用业界开放生态HCL语法的模板,它按照模板自动化部署指定的云服务资源。资源编排聚焦于华为云所用资源的自动化批量构建,帮助 - [产品优势](https://support.huaweicloud.com/productdesc-aos/rf_02_0003.md): 声明性:用户仅需直观描述所需资源的最终状态,屏蔽复杂的申请过程,降低资源管理的复杂度。幂等:资源描述代码多次调用效果幂等,可确保不重复申请资源。安全可靠:可视化的审计、安全、和合规控制策略,杜绝资源变更操作带来的安全风险。生态丰富:南向生态支持华为云主流服务(90+云服务、540+资源对象,详情参见:资源支持清单),开箱即用;北向完全兼容 - [应用场景](https://support.huaweicloud.com/productdesc-aos/rf_02_0004.md): 场景描述应用上云时,很多工作需要手工重复操作,例如环境的销毁和重建、在扩容的场景下重复完成多个新实例的配置等,手工操作容易带来操作失误。同时应用上云时,很多操作非常耗时,例如创建数据库、创建虚拟机等,手动操作容易失误,串行创建多个任务,就需要您持续等待较长时间。解决方案资源编排就是将上述场景的工作进行工具化、流程化。资源编排采用模板对应用 - [约束与限制](https://support.huaweicloud.com/productdesc-aos/rf_02_0005.md): 资源编排需要创建委托权限。资源编排对单个用户资源类型的数量限定了配额,如下表所示。如果您需要添加更多的模板或创建更多的资源栈,请提交工单申请。配额的详细信息请参见关于配额。 - [支持Provider版本列表](https://support.huaweicloud.com/productdesc-aos/rf_02_0006.md): Provider是将各类资源的API(比如资源的CRUD操作API)封装而成的插件,供资源编排引擎调用。目前Provider还在不断迭代维护中,旧版本可能存在功能缺陷,推荐使用最新版本以保障使用体验。最佳实践推荐使用>,>=运算符号显式约束Provider的版本,将会在约束范围内使用RFS已支持的版本。若使用Hcl格式模版可参考若使用Js - [责任共担](https://support.huaweicloud.com/productdesc-aos/rf_02_00071.md): 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击,华为云在遵从法律法规业界标准的基础上,以安全生态圈为护城河,依托华为独有的软硬件优势,构建面向不同区域和行业的完善云服务安全保障体系。与传统的本地数据中心相比,云计算的运营方和使用方分离,提供了更好的灵活性和控制力 - [身份认证与访问控制](https://support.huaweicloud.com/productdesc-aos/rf_02_00074.md): 身份认证租户使用RFS服务通常有两种调用方式:控制台访问和API调用。1.控制台身份认证方式RFS对接了统一身份认证服务(Identity and Access Management,IAM)。RFS租户身份认证与访问控制通过IAM权限控制。统一身份认证(Identity and Access Management,简称IAM)是华为云提 - [审计与日志](https://support.huaweicloud.com/productdesc-aos/rf_02_00072.md): 审计云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。RFS支持审计的操作事件,请参见云审计服务支持的RFS操作列表。日志用户开通云审计服务并创建和配置追踪器后,CTS可记录 - [认证证书](https://support.huaweicloud.com/productdesc-aos/rf_02_00073.md): 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。合规证书下载华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。资源中心华为云安全服务提供了网络安全专用产品安全检测证书、软件著作权等证书,供用户下载和参考。具体请查看合规资质证书。网络安全专用产品安全检测证书 ## 用户指南 - [访问资源编排服务](https://support.huaweicloud.com/usermanual-aos/rf_04_0020.md): 1.登录华为云控制台。在控制台页面中选择“服务列表>管理与监管>资源编排服务RFS”当前已支持访问资源编排服务的局点: - [资源栈状态](https://support.huaweicloud.com/usermanual-aos/rf_04_0001.md): 资源栈管理包括两方面的能力,一是对资源栈进行生命周期管理,包括创建、更新、删除、查询等操作;二是对资源栈下的执行计划进行生命周期管理,包括执行计划的创建、删除、查询等操作。资源栈生命周期中各状态说明如表1所示。执行计划生命周期中各状态说明如表2所示。 - [创建资源栈](https://support.huaweicloud.com/usermanual-aos/rf_04_0003.md): 注意:若下面步骤出现如下图报错,则参考基于IAM策略授权用户使用RFS前端页面给用户授权。进入资源栈列表页面单击页面右上角的“创建资源栈”,进入创建资源栈页面 如图1步骤:可使用已有模板或者可视化编辑器进行操作此处使用模板进行资源栈的创建,设计器使用见可视化编辑器。选择模板:此处有三种方式可以选择模板,一是通过OBS模板的URL指定模板, - [查询资源栈](https://support.huaweicloud.com/usermanual-aos/rf_04_0002.md): 步骤:进入资源编排控制台,单击左侧导航栏中的“资源栈”,进入资源栈列表页面在资源栈列表上方的输入框中输入要查找的资源栈名称,单击搜索图标即可,如图1: - [更新模板或参数](https://support.huaweicloud.com/usermanual-aos/rf_04_0004.md): 部署资源栈没有提供查看变更记录的功能,请谨慎操作,如果需要查看详细的变更内容,优先使用创建执行计划功能。部署资源栈没有提供查看变更记录的功能,请谨慎操作,如果需要查看详细的变更内容,优先使用创建执行计划功能。如果后您需要增加云服务资源,或者变更资源栈中某个资源的规格。需要进入资源栈列表页面,找到刚创建成功的资源栈,单击操作列的“更新”或者 - [创建执行计划](https://support.huaweicloud.com/usermanual-aos/rf_04_0005.md): 注:您也可以在创建资源栈的同时创建执行计划(详见创建执行计划)步骤:进入资源栈列表页面,单击资源栈名称进入资源栈详情,单击页面右上角的“更新模板或参数”进入创建执行计划页面如图1:后续步骤和创建资源栈一致,除了一个区别是,您需要单击创建执行计划,而不是单击直接部署资源栈。单击“创建执行计划”后 资源栈不会直接部署,而是创建执行计划,创建多 - [价格预估](https://support.huaweicloud.com/usermanual-aos/rf_04_0006.md): 进入创建成功的执行计划页面,会在界面上看到“查看费用明细”按钮,如图1 ,单击后服务会进行价格预估并展示价格预估结果,如图2费用明细页面分包年/包月,如图3,按需计费如图4,待支持如图5三个类别展示资源价格。包年/包月类、按需计费类展示按照包年/包月,按需计费方式购买的资源,待支持类展示暂不支持预估价格资源的列表,目前支持预估价格的资源列 - [删除资源栈](https://support.huaweicloud.com/usermanual-aos/rf_04_0007.md): 1.无删除保护进入资源栈列表页面,找到刚创建成功的资源栈,单击行操作列的“删除”,页面弹出确认删除框,在输入框中再次输入Delete,单击确定,即可删除。或者进入资源栈详情页单击页面右上角的“删除”的按钮,达到相同的效果,样例如图1:删除资源栈弹框2.存在删除保护当资源中删除保护选项为“开启”时,如图2如果在启用删除保护的情况下删除资源栈 - [资源栈详情](https://support.huaweicloud.com/usermanual-aos/rf_04_0008.md): 资源栈详情资源栈详情中主要包括六个功能模块如下(此处用上面创建好的,资源栈名称为“stack_20221206_0933_uiyn”的资源栈举例说明):基本信息:展示资源栈的基本信息如基本信息:基本信息资源:指的是“执行计划执行中生成的云服务的信息”,资源栈部署中生成的资源可在此页查看,如图2:资源事件:事件指的是执行的过程中和部署资源栈 - [通过OBS的URL指定模板](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002535771011.md): RFS服务支持资源栈创建、资源栈集创建、模板更新时,通过OBS URL指定模板。本章节帮助您通过控制台快速使用OBS的URL指定模板,步骤包括创建桶、上传模板文件、分享模板文件。前置步骤:编写模板文件由于obs桶需要上传本地文件,先在本地新增一个.tf或者.json后缀的文件,把要通过rfs部署的模板保存到文件中。步骤一:创建桶桶是OBS - [模板参数与DEW的凭据管理服务集成使用](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002517475640.md): 您可以通过华为云DEW的凭据管理服务(CSMS)结合Terraform实现敏感参数加密存储与安全调用,避免明文暴露敏感信息。前置步骤:创建或选择已有凭据进入DEW的凭据列表页面,创建或选择已有凭据。以创建凭据来储存弹性云服务器(ECS)的密码为例,输入凭据名称rfs-secret,凭据键ecs-admin-pass,凭据值为满足要求的密码 - [什么是可视化编辑器?](https://support.huaweicloud.com/usermanual-aos/rf_04_0018.md): 资源编排服务的可视化编辑器是一种用于创建、查看、修改模板的图形化工具。借助可视化编辑器,您可以将元素拖到画布中,直接连接它们,然后通过属性栏编辑这些元素的详细信息。不管您是新手,还是熟悉编排模板编写的专家,可视化编辑器都能帮助您快速了解模板中各项元素的关系,并轻松修改模板。使用可视化编辑器具备以下优势:可视化模板资源在可视化编辑器中,您可 - [可视化编辑器界面概述](https://support.huaweicloud.com/usermanual-aos/rf_04_0010.md): RFS可视编辑器UI由六个部分组成,分别是控制栏、资源栏、日志栏、设计台、模板栏和属性栏。可视化编辑器各部分详细功能说明如图1。 - [了解云服务/元素](https://support.huaweicloud.com/usermanual-aos/rf_04_0011.md): 云服务也可称为元素,是可视化编辑器设计编排的基本单位,任何元素都含有其所在类别资源的所有属性。可视化编辑器界面左侧对云服务资源进行了分类,任何云服务资源都可以拖拽到右侧的画布中。拖动云服务到画布中。右键单击此云服务。可查看到两个图标。单击“克隆”可复制一个相同的云服务,单击“删除”可删除该云服务。云服务中的资源框图目前有两类:第一类:不可 - [可视化编辑器快捷键](https://support.huaweicloud.com/usermanual-aos/rf_04_0012.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [使用可视化编辑器编写模板创建云硬盘](https://support.huaweicloud.com/usermanual-aos/rf_04_0019.md): 本教程将指导您通过“使用可视化编辑器编写模板”创建云硬盘。本次教程完成后,在云服务器控制台中可查看到一个已创建好的云硬盘,如图1。步骤一:使用可视化编辑器编写模板:使用可视化编辑器添加元素,用可视化编辑器集成的编辑器为各元素添加参数。步骤二:创建云硬盘:使用可视化编辑器创建弹性云服务器、虚拟私有云和子网。步骤三:清除资源:为了防止您为不需 - [资源栈管理](https://support.huaweicloud.com/usermanual-aos/rf_04_0013.md): 资源栈管理包括两方面的能力,一是对已创建的资源栈进行生命周期管理,包括删除、变更等;二是查看资源栈的详情信息,便于用户掌握资源栈的运行状态。资源栈创建成功后(状态为正常),可以根据自身需求变更资源栈输入参数。在资源栈详情页面的“事件”页签,可查看变更资源栈的具体操作事件。资源栈删除后不能恢复,请谨慎操作。请仔细核对资源栈的名称,执行删除后 - [资源栈集概念](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0001.md): 管理员账户和目标账户管理员账户:管理员账户是您用来创建资源栈集的华为云账户。对于具有服务托管权限的资源栈集,管理员账户是组织的管理账户或委托管理员账户。您可以通过登录到创建资源栈集的管理员账户来管理资源栈集。目标账户:目标账户是您用来创建、更新或删除资源栈集中的一个或多个资源栈的账户。先在管理员账户与目标账户之间设置信任关系,然后才能使用 - [使用资源栈集](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0002.md): 要为创建具有服务托管的资源栈集设置必要的权限。您需要先通过在各个账户中创建IAM角色以在管理员和目标账户之间建立信任关系,然后才能创建具有自助服务权限的资源栈集。确定哪个华为云账户是管理员账户。资源栈集是在该管理员账户中创建的。目标账户是在其中创建属于资源栈集的各个资源栈的账户。资源栈集是在该管理员账户中创建的。目标账户是在其中创建属于资 - [创建资源栈集](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0003.md): 本章节帮助您通过自助服务权限创建资源栈集。服务管理权限见通过服务管理权限创建资源栈集。注意:若下面步骤出现如下图报错,则参考基于IAM策略授权用户使用RFS前端页面给用户授权。1.进入资源栈集列表页面,单击页面右上角的“创建资源栈集”,进入创建资源栈集页面 如图12.进入选择模板操作界面图2,在模板操作界面提供以下信息。确认信息无误单击下 - [更新资源栈集](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0004.md): 1.进入资源栈集界面,单击需要创建资源栈的资源栈集名称进入。2.进入资源栈实例界面右上角单击“更新”按钮3.进入选择模板页面,此处可以选择两种创建方式“1.使用当前模板”“2.替换当前模板”此时,选择"使用当前模板"或者"替换当前模板"即使用一个新模板来进行已有资源栈集的更新功能。方案一:使用当前模板:单击“下一步”,进入参数配置页面,对 - [从资源栈集中创建资源栈实例](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0005.md): 1.进入资源栈集界面,找到需要创建资源栈实例的资源栈集,单击资源栈集名称进入资源栈实例界面。2.进入资源栈实例界面单击“新增”按钮3.进入部署资源栈实例界面图1,填写需要创建的租户id和部署区域。确认无误单击下一步4.确认参数无误,单击部署并确定。5.等待创建成功查看创建结果,显示操作完成则创建成功。 - [从资源栈集中删除资源栈实例](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0006.md): 1.进入资源栈集界面,找到需要删除资源栈实例的资源栈集,单击资源栈集名称进入资源栈实例界面。2.进入资源栈实例界面,找到需要删除的资源栈实例,单击右侧操作列的“删除”按钮。3.在删除资源栈实例弹出框中选择“确认”进行删除。 - [删除资源栈集](https://support.huaweicloud.com/usermanual-aos/rf_StackSets_0007.md): 1.进入资源栈集界面,找到需要删除的资源栈集,单击资源栈集名称进入资源栈实例界面。2.进入资源栈实例界面,对当前资源栈集下的所有资源栈实例进行删除操作。3.确认当前资源栈集下资源栈实例数量为0。4.单击界面右上角删除按钮进行删除,在删除资源栈集弹出框中输入“Delete”确认删除,等待资源栈集删除成功。 - [通过服务管理权限创建资源栈集](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002504087184.md): RFS支持Organization云服务的组织管理账号及组织成员账号通过服务管理权限创建资源栈集,并部署资源到组织下的每个账号中。步骤一:确定需要部署的组织单元ID1.登录Organization服务。2.点击需要部署资源栈集的组织单元,点击ID的复制按钮。步骤二:创建资源栈集1.进入资源栈集列表页面,单击页面右上角的“创建资源栈集”,进 - [云审计服务支持的RFS操作列表](https://support.huaweicloud.com/usermanual-aos/rf_04_0015.md): 云审计服务(Cloud Trace Service,简称CTS),能够记录各云服务每次操作详细信息,为客户在问题定位、资源管理、安全审计方面提供数据支撑。开启云审计服务后,CTS系统开始记录RFS资源的操作。 - [查看RFS云审计日志](https://support.huaweicloud.com/usermanual-aos/rf_04_0016.md): 开启云审计服务后,系统开始记录RFS资源的操作。您可以按照如下操作在云审计服务管理控制台查看最近7天的操作记录。当前事件列表支持四个维度的组合查询,详细信息如下:事件来源、资源类型和筛选类型。直接在下拉框中选择查询条件。例如,在事件来源下拉框中选择“云服务”并搜索”RF”。其中,筛选类型选择事件名称时,还需选择某个具体的事件名称。选择资源 - [IAM委托](https://support.huaweicloud.com/usermanual-aos/rf_04_0017.md): 通过创建委托,可以将资源共享给其他账号,或委托更专业的人或团队来代为管理资源。被委托方使用自己的账号登录后,切换到委托方账号,即可管理委托方委托的资源,避免委托方共享自己的安全凭证(密码/密钥)给他人,确保账号安全。用户在使用RFS时,可以通过创建资源栈设置委托与Provider的绑定关系,通过更新资源栈更新委托与Provider的绑定关 - [基于角色与策略授权创建用户授权使用RFS](https://support.huaweicloud.com/usermanual-aos/rf_06_0001.md): 如果您需要对您所拥有的资源编排服务(RFS)进行角色与策略的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以:根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用RFS服务。根据企业用户的职能,设 - [基于身份策略授权创建用户授权使用RFS](https://support.huaweicloud.com/usermanual-aos/rf_06_0002.md): 如果您需要对您所拥有的资源编排服务(RFS)进行身份策略的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以:根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建用户或用户组,让员工拥有唯一安全凭证,并使用RFS服务。根据企业用户的职能,设 - [基于自定义策略授权创建用户授权使用RFS](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002550071545.md): 如果您需要对您所拥有的资源编排服务(RFS)进行自定义权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以:根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建用户或用户组,让员工拥有唯一安全凭证,并使用RFS服务。根据企业用户的职能,设置不 - [按身份策略配置](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002222622548.md): 登录统一身份认证服务控制台。在统一身份认证服务的左侧导航窗格中,选择“用户”页签,在右侧用户列表选择对应用户,单击“授权”选择“按身份策略配置”,搜索“IAMReadOnlyPolicy”,选中后确定,完成授权。由于前端只需要"iam:agencies:list"和"iam:agencies:listV5"两个IAM Action权限,步 - [按用户组配置](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002222782372.md): 登录统一身份认证服务控制台。在统一身份认证服务的左侧导航窗格中,选择“用户组”页签,在右侧用户组列表选择对应用户加入的任一用户组,单击“授权”。搜索“IAMReadOnlyPolicy”,选中后确定,完成授权。由于前端只需要"iam:agencies:list"和"iam:agencies:listV5"两个IAM Action权限,步骤 - [创建自定义身份策略](https://support.huaweicloud.com/usermanual-aos/toctopics/zh-cn_topic_0000002257781221.md): 登录统一身份认证服务控制台。在统一身份认证服务的左侧导航窗格中,选择“身份策略”页签,单击右上方的“创建自定义身份策略”。3. 策略名称自定义,策略配置方式选择“JSON视图”,策略内容如下(根据实际需求替换),单击“确定”完成创建 ## 模板参考 - [模板简介](https://support.huaweicloud.com/tr-aos/rf_05_0001.md): RFS服务主要包含模板和资源栈两部分,其中资源栈是指用户通过RFS服务创建的华为云资源的集合,而模板是用来创建、更新资源栈的脚本。 - [基本语法](https://support.huaweicloud.com/tr-aos/rf_05_0003.md): RFS配置语言兼容HCL语法,具有配置简单,可读性强等特点,并且兼容JSON语法。本文主要介绍HCL语言的基本语法及常见函数。RFS配置语言主要由参数(Argument),块(Block),表达式(Experssion)和函数(Functions)组成。使用等号将一个值或表达式赋值给指定的参数名称,参数名称可以使用字母、数字、下划线(_) - [样式约定](https://support.huaweicloud.com/tr-aos/rf_05_0004.md): HCL约定了一些惯用的风格样式,以确保不同团队编写的文件和模块的风格一致性。建议用户遵循这些约定,推荐的样式约定如下:对于每个嵌套级别,缩进两个空格。当多个单行的参数在同一嵌套级别连续出现时,建议将等号对齐。name = "myinstance" security_groups = ["default", "inte - [表达式](https://support.huaweicloud.com/tr-aos/rf_05_0005.md): 表达式用于引用或计算配置中的值,最简单的表达式是文字表达式,如 "hello world" 或5。Terraform支持多种表达式,包括运算符、条件表达式以及丰富的内置函数。通过 "terraform console" 命令可以打开一个交互式的控制台,您可以使用该控制台进行表达式及内置函数的体验和测试。运算符是执行特定的数学或逻辑操作的服 - [常见函数](https://support.huaweicloud.com/tr-aos/rf_05_0006.md): HCL支持丰富的内置函数,用于处理字符串、数值计算、加密,类型转换等操作,您可以通过函数名称进行调用,其语法如下:本文主要对HCL中常见的函数进行总结并通过样例说明其用法。您可以通过Terraform 官方文档查看完整的函数支持列表。base64sha512("Hello, cloud!")不等于base64encode(sha512(" - [Provider](https://support.huaweicloud.com/tr-aos/rf_05_0008.md): Terraform的配置文件以 ".tf" 或".tf.json"结尾,主要由provider,resource,data source和变量组成。每个 Provider 代表一个服务提供商,Terraform 通过插件机制与Provider进行交互。Provider通过关键字 "provider" 进行声明,Provider的配置参数请 - [Resource](https://support.huaweicloud.com/tr-aos/rf_05_0009.md): Resource 是Terraform中最重要的元素,通过关键字 "resource" 进行声明。Provider中支持的云服务都有一个或多个资源与之对应,如huaweicloud_compute_instance表示ECS,huaweicloud_vpc表示VPC等。资源之间的关系可以通过关系型资源进行关联,如可以使用 huaweicl - [Data Source](https://support.huaweicloud.com/tr-aos/rf_05_0010.md): Data SourceData Source 可以认为是特殊的Resource,通过关键字 "data" 进行声明。Data Source 用于查询已经存在资源的属性和信息,例如可以通过 "Ubuntu 18.04 server 64bit" 的镜像名称查询得到对应镜像的ID及其他属性:查询到镜像之后,您可以引用该镜像的属性供其他资源使用 - [输入变量](https://support.huaweicloud.com/tr-aos/rf_05_0012.md): 输入变量可以理解为模块的参数,通过关键字 "variable" 进行声明。通过定义输入变量,您可以无需变更模块的源代码就能灵活修改配置。输入变量的值可以使用默认值,CLI 选项,环境变量等方式来设置。按照约定,输入变量通常在名为 variables.tf 的文件中定义。输入变量通过关键字 "variable" 进行声明:variable - [输出变量](https://support.huaweicloud.com/tr-aos/rf_05_0013.md): 输出变量可以理解为模块的返回值,通过关键字 "output" 进行声明。输出变量是一种对外公开某些信息的方法,既可以在根模块中运行 terraform apply/output 命令输出特定的值,又可以在子模块中将资源的属性值提供给父模块。按照约定,输出变量通常在名为 variables.tf 的文件中定义。输出变量通过“output”关 - [本地变量](https://support.huaweicloud.com/tr-aos/rf_05_0014.md): 本地变量可以理解为模块中的临时变量,其作用范围在所声明的模块内,通过关键字 "locals" 进行声明。本地变量适用于配置中有重复定义相同值或表达式的场景,可以减少代码冗余,并且易于修改。同时过度使用本地变量会导致变量的实际值被隐藏,代码晦涩,不利于维护,因此建议合理使用本地变量。本地变量通过“locals”关键字进行声明:本地变量的表达 - [Metadata说明](https://support.huaweicloud.com/tr-aos/rf_05_0016.md): Metadata是Terraform支持的内置元参数,可以在 provider,resource,data块中使用。本章节主要介绍 resource块支持的元参数,主要包括:depends_on:用于指定资源的依赖项count:用于创建多个相同配置的资源for_each:用于根据映射、字符串集合创建多个资源provider:用于选择非默认 - [depends_on](https://support.huaweicloud.com/tr-aos/rf_05_0017.md): 在同一个 Terraform 配置文件中可以包含多个资源。通过在资源中引用其他资源的属性值,Terraform可以自动推断出资源的依赖关系。然而,某些资源的依赖关系对于Terraform是不可见的,这就需要使用 depends_on 来创建显式依赖。您可以使用 depends_on 来更改资源的创建顺序或执行顺序,使其在所依赖资源之后处理 - [count](https://support.huaweicloud.com/tr-aos/rf_05_0018.md): 默认情况下,Terraform的 resource块只配置一个资源。当需要创建多个相同的资源时,如果配置多个独立的 resource块就显得很冗余,且不利于维护。可以使用 count 或 for_each 参数在同一个 resource块中管理多个相同的资源。在同一个 resource块中不能同时使用count 和 for_each 参数 - [for_each](https://support.huaweicloud.com/tr-aos/rf_05_0019.md): for_each 在功能上与 count 相似,for_each 使用键值对或字符串集合的形式快速地将值填入到对应的属性中,不仅可以优化脚本结构也有利于理解多实例间的关系。在使用映射类型表达时,您可以使用 "each.key" 和 "each.value" 来访问映射的键和值。以创建VPC为例,通过 for_each 中的键值对,您可以灵 - [provider](https://support.huaweicloud.com/tr-aos/rf_05_0020.md): 在Terraform中,您可以使用 provider块创建多个配置,其中一个 provider块为默认配置,其它块使用 "alias" 标识为非默认配置。在资源中使用元参数 provider 可以选择非默认的 provider块。例如需要在不同的地区管理资源,首先需要声明多个 provider块:示例中声明了北京和广州的华为云provid - [lifecycle](https://support.huaweicloud.com/tr-aos/rf_05_0021.md): 每个资源实例都具有创建 、更新和销毁三个阶段,在一个资源实例的生命周期过程中都会经历其中的2至3个阶段。通过元参数 lifecycle 可以对资源实例的生命周期过程进行改变,lifecycle 支持以下参数:create_before_destroy默认情况下,当需要改变资源中不支持更新的参数时,Terraform会先销毁已有实例,再使用 - [Extension简介](https://support.huaweicloud.com/tr-aos/rf_05_0026.md): Extension用于承载RFS系统的扩展能力,这些扩展文件用户可以直接操作和编写。Extension是RFS支持的内置元参数,可以在模板中配置使用,方便用户更好的配置参数。本章节主要介绍Extension相关参数 ,主要包括:i18n:代表要使用多语义化功能variables:代表要使用参数预加载功能 - [Extension使用](https://support.huaweicloud.com/tr-aos/rf_05_0027.md): 使用Extension注意:1.在zip压缩包根目录下新建.extension文件夹2.".extension"文件夹下新建后缀名为.rfs.json的扩展文件,当前只支持扩展功能写在单个文件中 - [多语义化](https://support.huaweicloud.com/tr-aos/rf_05_0024.md): 参数多语言支持对variable的参数名字、描述和类型进行词条翻译,当前支持zh_cn、en_us两种语义i18n中示例如下: - [参数预加载](https://support.huaweicloud.com/tr-aos/rf_05_0025.md): 参数预加载支持输入参数时请求云服务api获取预加载选项,当前支持以下六种api接口:variables使用样例:"variables":[ { "name": "参数name", "prompt": "hwc:vpc:mySubnets", "quer - [模板约束与限制](https://support.huaweicloud.com/tr-aos/rf_05_0028.md): 使用RFS服务进行模板部署,模板文件内容具有如下约束与限制:模块的数量限制为50,模块嵌套深度限制为3。模板中对count参数的值最大限制为1024。模板中对for_each参数所遍历的键值对数量最大限制为1024。不能使用Provisioners功能、Backend Configuration功能和Cloud 功能。可以使用Module ## API参考 - [概述](https://support.huaweicloud.com/api-aos/aos_02_0001.md): RFS提供了最新的资源编排API,推荐您使用最新的API功能!欢迎使用资源编排服务(RFS)。资源编排服务是完全支持业界事实标准Terraform(HCL + Provider)的新一代云服务资源终态编排引擎,在应用编排服务(AOS)基础上实现了生态、体验、特性的全新升级;资源编排服务基于业界开放生态HCL语法模板,实现云服务资源的自动化 - [基本概念](https://support.huaweicloud.com/api-aos/aos_02_0055.md): 账号用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用该用户进行日常管理工作。用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主 - [构造请求](https://support.huaweicloud.com/api-aos/rfs_02_0007.md): 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。请求URI由如下部分组成:{URI-sc - [认证鉴权](https://support.huaweicloud.com/api-aos/rfs_02_0004.md): 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。Token认证:通过Token认证调用请求。AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。Token认证:通过Token认证调用请求。AK/SK认证:通过AK( - [返回结果](https://support.huaweicloud.com/api-aos/rfs_02_0006.md): 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。对于获取用户Token接口,如果调用后返回状态码为201,则表示请求成功。对应请求消息头,响应同样也有消息头,如Content-type。对于获取用户Token接口,返回如图1所 - [列举资源栈事件](https://support.huaweicloud.com/api-aos/ListStackEvents.md): 列举资源栈事件(ListStackEvents)此API用于列举资源栈某一次或全部的部署事件如果给予deployment_id,则会将deployment_id作为查询条件,返回对应某一次部署的资源栈事件;如果不给予deployment_id,则返回全量的资源栈事件如果给予deployment_id,则会将deployment_id作为查 - [获取资源栈元数据](https://support.huaweicloud.com/api-aos/GetStackMetadata.md): 获取资源栈元数据(GetStackMetadata)此API用于获取指定资源栈的元数据,包括资源栈ID、资源栈名称、资源栈描述、创建时间、更新时间、资源栈状态、委托授权等信息。具体信息见GetStackMetadataResponseBody。注:当资源栈状态处于非终态(即以IN_PROGRESS结尾,详细见下方)状态时,资源栈的元数据信 - [列举资源栈](https://support.huaweicloud.com/api-aos/ListStacks.md): 列举资源栈(ListStacks)此API用于列举当前局点下用户所有的资源栈默认按照生成时间降序排序,最新生成的在最前默认按照生成时间降序排序,最新生成的在最前如果没有任何资源栈,则返回空list如果没有任何资源栈,则返回空list支持分页返回。如果响应中存在next_marker,则表示实际总输出比当前响应中包含的输出多。在对请求的后续 - [创建资源栈](https://support.huaweicloud.com/api-aos/CreateStack.md): CreateStack用于生成一个资源栈当请求中不含有模板(template)、参数(vars)等信息,将生成一个无任何资源的空资源栈,返回资源栈ID(stack_id)当请求中不含有模板(template)、参数(vars)等信息,将生成一个无任何资源的空资源栈,返回资源栈ID(stack_id)当请求中携带了模板(template)、 - [获取资源栈模板](https://support.huaweicloud.com/api-aos/GetStackTemplate.md): 获取资源栈模板(GetStackTemplate)此API用于获取资源栈最近一次部署终态使用的模板。注:当资源栈状态处于非终态(即以IN_PROGRESS结尾,详细见下方)状态时,资源栈处于转变阶段,此API获取资源栈上一次部署使用的模板。只有当资源栈状态处于终态(即以COMPLETE或FAILED结尾,详细见下方)时,此API获取当前最 - [列举资源栈资源](https://support.huaweicloud.com/api-aos/ListStackResources.md): 列举资源栈资源(ListStackResources)此API用于列举资源栈中当前管理的所有资源的信息当资源栈处于非终态时,仅输出资源栈下资源的简要信息,包含逻辑资源名称(logical_resource_name),逻辑资源类型(logical_resource_type),物理资源id(physical_resource_id),物理 - [列举资源栈输出](https://support.huaweicloud.com/api-aos/ListStackOutputs.md): 列举资源栈输出(ListStackOutputs)此API用于列举该资源栈的所有输出资源栈输出为用户在模板中定义的 output 语句块在部署结束后所产生的返回信息,用户可在部署结束后,调用此API获取其具体的输出信息当资源栈状态处于非终态(状态以IN_PROGRESS结尾)状态时,此API将返回空。非终态包括但不限于以下状态:正在部署( - [继续部署资源栈](https://support.huaweicloud.com/api-aos/ContinueDeployStack.md): 继续部署资源栈(ContinueDeployStack)此API用于继续部署一个已有的资源栈如果资源栈当前可以继续部署,即处于DEPLOYMENT_FAILED,则返回202与对应生成的deploymentId,否则将不允许继续部署并返回相应的错误码如果资源栈当前可以继续部署,即处于DEPLOYMENT_FAILED,则返回202与对应生 - [部署资源栈](https://support.huaweicloud.com/api-aos/DeployStack.md): 部署资源栈(DeployStack)此API用于部署一个已有的资源栈用户可以使用此API更新模板、参数等并触发一个新的部署用户可以使用此API更新模板、参数等并触发一个新的部署此API会直接触发部署,如果用户希望先确认部署会发生的时间,请使用执行计划,即使用CreateExecutionPlan以创建执行计划、使用GetExecution - [删除资源栈](https://support.huaweicloud.com/api-aos/DeleteStack.md): 删除资源栈(DeleteStack)此API用于删除某个资源栈请谨慎操作,删除资源栈将会删除与该资源栈相关的所有数据和资源,如:执行计划、资源栈事件、资源栈输出、资源等。此API会触发删除资源栈,并以最终一致性删除所有数据(包括通过资源栈模板创建以及通过Import模块导入的已有资源),用户可以调用GetStackMetadata或Lis - [更新资源栈](https://support.huaweicloud.com/api-aos/UpdateStack.md): 更新资源栈(UpdateStack)更新资源栈的属性,该API可以根据用户给予的信息对资源栈的属性进行更新,可以更新资源栈的“description”、“enable_deletion_protection”、"enable_auto_rollback"、"agencies"四个属性中的一个或多个该API只会更新用户给予的信息中所涉及的字 - [条件删除资源栈](https://support.huaweicloud.com/api-aos/DeleteStackEnhanced.md): 条件删除资源栈(DeleteStackEnhanced)此API用于删除某个资源栈,可以选择是否保留资源。请谨慎操作,删除资源栈将默认删除与该资源栈相关的所有数据,如:执行计划、资源栈事件、资源栈输出、资源等。如果希望删除资源栈保留资源,可以在请求中设置retain_all_resources对资源进行保留。此API会触发删除资源栈,并以 - [继续回滚资源栈](https://support.huaweicloud.com/api-aos/ContinueRollbackStack.md): 继续回滚资源栈(ContinueRollbackStack)此API用于继续回滚一个已有的资源栈如果资源栈开启了自动回滚,在部署失败的时候则会自动回滚。但是自动回滚依然有可能失败,用户可以根据错误信息修复后,调用ContinueRollbackStack触发继续回滚,即重试回滚如果资源栈当前可以回滚,即处于ROLLBACK_FAILED, - [列举执行计划](https://support.huaweicloud.com/api-aos/ListExecutionPlans.md): 列举执行计划(ListExecutionPlans)列举当前局点下用户指定资源栈下所有的执行计划默认按照生成时间降序排序,最新生成的在最前默认按照生成时间降序排序,最新生成的在最前如果指定的资源栈下没有任何执行计划,则返回空list如果指定的资源栈下没有任何执行计划,则返回空list如果指定的资源栈不存在,则返回404如果指定的资源栈不存 - [创建执行计划](https://support.huaweicloud.com/api-aos/CreateExecutionPlan.md): 创建执行计划(CreateExecutionPlan)此API用于在指定的资源栈下生成一个执行计划,执行计划描述了当前资源栈中记录的资源状态和模板描述的目的资源状态之间的区别(如,资源A将以以下配置文件生成,资源B将以下参数从XXX修改成YYY)调用此API触发创建执行计划之后,可以通过GetExecutionPlanMetadata来跟 - [获取执行计划](https://support.huaweicloud.com/api-aos/GetExecutionPlan.md): 获取执行计划(GetExecutionPlan)此API用于获取指定执行计划的详细内容(即执行计划项目),用户可通过此API得知指定执行计划在执行后,资源栈中的资源会发生何种变化如果执行计划状态为CREATION_IN_PROGRESS或CREATION_FAILED,则不返回执行计划项目列表您可以在API Explorer中调试该接口, - [执行执行计划](https://support.huaweicloud.com/api-aos/ApplyExecutionPlan.md): 执行执行计划(ApplyExecutionPlan)此API用于执行一个执行计划当执行请求接受后,执行计划状态将变为APPLY_IN_PROGRESS,后台会进行异步处理。当执行请求接受后,执行计划状态将变为APPLY_IN_PROGRESS,后台会进行异步处理。当执行结束后,执行计划状态将变为APPLIED。当执行结束后,执行计划状态将 - [删除执行计划](https://support.huaweicloud.com/api-aos/DeleteExecutionPlan.md): 删除执行计划(DeleteExecutionPlan)删除指定的执行计划如果执行计划状态处于CREATION_IN_PROGRESS、APPLY_IN_PROGRESS状态时,则不允许删除并返回403您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试 - [获取执行计划元数据](https://support.huaweicloud.com/api-aos/GetExecutionPlanMetadata.md): 获取执行计划元数据(GetExecutionPlanMetadata)该API可以获取指定执行计划的元数据,包括资源栈ID、资源栈名称、执行计划ID、执行计划名称、执行计划描述、执行计划的创建时间和执行时间、执行计划状态等信息。具体信息见GetExecutionPlanMetadataResponseBody。如果需要获取执行计划的具体内 - [预估执行计划价格](https://support.huaweicloud.com/api-aos/EstimateExecutionPlanPrice.md): 预估执行计划价格(EstimateExecutionPlanPrice)此API可以基于一份已有的执行计划中增量的资源进行询价,当前支持询价的计费模式有包周期计费、按需计费、免费,暂不支持其他形式的计费模式,例如竞价计费模式等。注:由于某些资源的属性值含有默认值,且该属性和询价参数相关。如果用户的模板中描述的资源没有声明这些属性,则询价结 - [解析模板参数](https://support.huaweicloud.com/api-aos/ParseTemplateVariables.md): 解析模板参数(ParseTemplateVariables)此API用于解析用户输入的模板中的参数(variable),将解析模板中的所有variable块并返回如果用户传入的模板中定义了variable参数,则返回200和所有variable如果用户传入的模板中定义了variable参数,则返回200和所有variable如果用户传入的 - [列举模板](https://support.huaweicloud.com/api-aos/ListTemplates.md): 列举模板(ListTemplates)此API用于列举当前局点下用户所有的模板默认按照生成时间降序排序,最新生成的模板排列在最前面默认按照生成时间降序排序,最新生成的模板排列在最前面如果没有任何模板,则返回空list如果没有任何模板,则返回空list如果用户需要详细的模板版本信息,请调用ListTemplateVersions如果用户需要 - [创建模板](https://support.huaweicloud.com/api-aos/CreateTemplate.md): 创建模板(CreateTemplate)此API用于创建一个带有版本的模板请求中必须包括template_uri或是template_body。前者为模板内容obs链接,后者为模板内容请求中必须包括template_uri或是template_body。前者为模板内容obs链接,后者为模板内容模板管理名仅仅在同一时间下唯一,即用户允许先生 - [删除模板](https://support.huaweicloud.com/api-aos/DeleteTemplate.md): 删除模板(DeleteTemplate)此API用于删除某个模板以及模板下的全部模板版本请谨慎操作,删除模板将会删除模板下的所有模板版本。template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模 - [更新模板元数据](https://support.huaweicloud.com/api-aos/UpdateTemplateMetadata.md): 更新模板元数据(UpdateTemplateMetadata)此API用于更新模板元数据此api只支持更新模板描述此api只支持更新模板描述您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。PATCH /v1/{project_id}/temp - [获取模板元数据](https://support.huaweicloud.com/api-aos/ShowTemplateMetadata.md): 获取模板元数据(ShowTemplateMetadata)此API用于获取当前模板的元数据信息具体信息见ShowTemplateMetadataResponseBody,如果想查看模板下全部模板版本,请调用ListTemplateVersions。template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID - [列举模板版本](https://support.huaweicloud.com/api-aos/ListTemplateVersions.md): 列举模板版本信息(ListTemplateVersions)此API用于列举模板下所有的模板版本信息默认按照生成时间降序排序,最新生成的模板排列在最前面默认按照生成时间降序排序,最新生成的模板排列在最前面如果没有任何模板版本,则返回空list如果没有任何模板版本,则返回空listtemplate_id是模板的唯一Id。此Id由资源编排服务 - [创建模板版本](https://support.huaweicloud.com/api-aos/CreateTemplateVersion.md): 创建模板版本(CreateTemplateVersion)此API用于创建新的模板版本请求中必须包括template_uri或template_body。前者为模板内容obs链接,后者为模板内容请求中必须包括template_uri或template_body。前者为模板内容obs链接,后者为模板内容新创建的模板版本版本ID会自动在当前最 - [删除模板版本](https://support.huaweicloud.com/api-aos/DeleteTemplateVersion.md): 删除模板版本(DeleteTemplateVersion)此API用于删除某个模板版本template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户可能希望确保当前我操作的模 - [获取模板版本内容](https://support.huaweicloud.com/api-aos/ShowTemplateVersionContent.md): 获取模板版本内容(ShowTemplateVersionContent)此API用于获取用户的模板版本内容template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户可能希 - [获取模板版本元数据](https://support.huaweicloud.com/api-aos/ShowTemplateVersionMetadata.md): 获取模板版本元数据(ShowTemplateVersionMetadata)此API用于展示某一版本模板的元数据template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户 - [列举资源栈集](https://support.huaweicloud.com/api-aos/ListStackSets.md): 列举资源栈集(ListStackSets)此API用于列举当前用户(domain)当前局点(region)下全部资源栈集。可以使用filter作为过滤器,过滤出指定权限模型(permission_model)下的资源栈集。可以使用filter作为过滤器,过滤出指定权限模型(permission_model)下的资源栈集。可以使用sort_ - [创建资源栈集](https://support.huaweicloud.com/api-aos/CreateStackSet.md): 创建资源栈集(CreateStackSet)此API为同步API,用于生成一个空资源栈集,即不包含任何一个资源栈实例,并返回资源栈集ID(stack_set_id)您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。POST /v1/stack- - [获取资源栈集模板](https://support.huaweicloud.com/api-aos/ShowStackSetTemplate.md): 获取资源栈集模板(ShowStackSetTemplate)此API用于获取指定资源栈集的模板。如果获取成功,则以临时重定向形式返回模板下载链接(OBS Pre Signed地址,有效期为5分钟),大多数的客户端会进行自动重定向并下载模板;如果未进行自动重定向,请参考HTTP的重定向规则获取模板下载链接,手动下载模板。您可以在API Ex - [列举资源栈集操作](https://support.huaweicloud.com/api-aos/ListStackSetOperations.md): 列举资源栈集操作(ListStackSetOperations)列举指定资源栈集下所有的资源栈集的操作。可以使用filter作为过滤器,过滤出指定操作状态(status)或操作类型(action)下的资源栈集操作。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_k - [获取资源栈集元数据](https://support.huaweicloud.com/api-aos/ShowStackSetMetadata.md): 获取资源栈集元数据(ShowStackSetMetadata)用户可以使用此API获取资源栈集的元数据用户可以使用此API获取资源栈集的元数据您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。GET /v1/stack-sets/{stack_ - [列举资源栈实例](https://support.huaweicloud.com/api-aos/ListStackInstances.md): 列举资源栈实例(ListStackInstances)此API用于列举指定资源栈集下指定局点(region)或指定成员账号(stack_domain_id)或全部资源栈实例可以使用filter作为过滤器,过滤出指定局点(region)或指定成员账号(stack_domain_id)下的资源栈实例可以使用filter作为过滤器,过滤出指定局 - [创建资源栈实例](https://support.huaweicloud.com/api-aos/CreateStackInstance.md): 创建资源栈实例(CreateStackInstance)此API用于在指定资源栈集下生成多个资源栈实例,并返回资源栈集操作ID(stack_set_operation_id)此API可以通过var_overrides参数,指定创建资源栈实例的参数值,进行参数覆盖。如果var_overrides参数未给予,则默认使用当前资源栈集中记录的参数 - [删除资源栈实例-已废弃](https://support.huaweicloud.com/api-aos/DeleteStackInstanceDeprecated.md): 删除资源栈实例-被废弃(DeleteStackInstanceDeprecated)此API用于删除指定资源栈集下指定局点(region)或指定成员账号(domain_id)的资源栈实例,并返回资源栈集操作ID(stack_set_operation_id)请谨慎操作,删除资源栈实例将会删除与该资源栈实例相关的资源栈以及资源栈所管理的一切 - [更新资源栈实例](https://support.huaweicloud.com/api-aos/UpdateStackInstances.md): 更新资源栈实例(UpdateStackInstances)此API用于更新并部署指定资源栈实例集合,并返回资源栈集操作ID(stack_set_operation_id)此API可以通过var_overrides参数,更新指定资源栈实例的参数值,进行参数覆盖。如果var_overrides参数未给予,则默认使用当前资源栈集中记录的参数进行 - [删除资源栈实例](https://support.huaweicloud.com/api-aos/DeleteStackInstance.md): 删除资源栈实例(DeleteStackInstance)此API用于删除指定资源栈集下指定局点(region)或指定成员账号(domain_id)的资源栈实例,并返回资源栈集操作ID(stack_set_operation_id)请谨慎操作,删除资源栈实例将会删除与该资源栈实例相关的资源栈以及资源栈所管理的一切资源。用户可以根据资源栈集操 - [部署资源栈集](https://support.huaweicloud.com/api-aos/DeployStackSet.md): 部署资源栈集(DeployStackSet)此API用于部署一个已有的资源栈集,并返回资源栈集操作ID(stack_set_operation_id)用户可以使用此API更新资源栈集的模板、参数并进行部署。用户可以使用此API更新资源栈集的模板、参数并进行部署。此API会直接触发资源栈实例部署。用户既可以部署资源栈集下所有的资源栈实例,也 - [删除资源栈集](https://support.huaweicloud.com/api-aos/DeleteStackSet.md): 删除资源栈集(DeleteStackSet)请谨慎操作,删除资源栈集将会删除与该资源栈集相关的所有数据,如:资源栈集操作、资源栈集操作事件等。当且仅当指定的资源栈集满足以下所有条件时,资源栈集才能被成功删除,否则会报错:资源栈集下没有资源栈实例资源栈集下没有资源栈实例资源栈集状态处于空闲(IDLE)状态资源栈集状态处于空闲(IDLE)状态 - [更新资源栈集](https://support.huaweicloud.com/api-aos/UpdateStackSet.md): 更新资源栈集(UpdateStackSet)该API可以根据用户给予的信息对资源栈集的属性进行更新,可以更新资源栈集如下属性“stack_set_description”、"initial_stack_description"、“administration_agency_name”、"managed_agency_name"、“admi - [获取资源栈集操作的元数据](https://support.huaweicloud.com/api-aos/ShowStackSetOperationMetadata.md): 获取资源栈集操作元数据(ShowStackSetOperationMetadata)此API用于获取指定资源栈集操作的元数据,包括资源栈集操作ID、资源栈集ID、资源栈集名称、资源栈集操作状态、创建时间、更新时间、部署目标等信息。具体信息见ShowStackSetOperationMetadataResponseBody。您可以在API - [获取资源栈实例](https://support.huaweicloud.com/api-aos/ShowStackInstance.md): 获取资源栈实例(ShowStackInstance)用户可以使用此API获取资源栈实例的详细信息,包括关联资源栈名称与id,创建时间,参数覆盖等您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。GET /v1/stack-sets/{stack - [创建私有provider](https://support.huaweicloud.com/api-aos/CreatePrivateProvider.md): 创建私有provider(CreatePrivateProvider)创建一个私有的空provider。如果用户给予了provider_version和function_graph_urn,则在创建私有provider的同时,还会在私有provider下创建一个私有provider版本。私有provider允许用户将自定义的provide - [列举私有provider](https://support.huaweicloud.com/api-aos/ListPrivateProviders.md): 列举私有provider(ListPrivateProviders)列举当前局点下用户所有的私有provider。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir,则默 - [创建私有provider版本](https://support.huaweicloud.com/api-aos/CreatePrivateProviderVersion.md): 创建私有provider版本(CreatePrivateProviderVersion)版本号遵循语义化版本(Semantic Versioning)规范,支持用户自定义。其各层级(Major.Minor.Patch)均采用无符号 64 位整型(uint64)。版本号遵循语义化版本(Semantic Versioning)规范,支持用户自 - [列举私有provider版本](https://support.huaweicloud.com/api-aos/ListPrivateProviderVersions.md): 列举私有provider版本(ListPrivateProviderVersions)列举所选择的私有provider中所有的provider版本信息。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予s - [删除私有provider](https://support.huaweicloud.com/api-aos/DeletePrivateProvider.md): 删除私有provider(DeletePrivateProvider)删除某个私有provider及私有provider下的所有provider版本。如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。如果provider_name和provider_id同时存在,则 - [获取私有provider元数据](https://support.huaweicloud.com/api-aos/ShowPrivateProviderMetadata.md): 获取私有provider元数据(ShowPrivateProviderMetadata)获取某个私有provider的元数据信息具体返回的信息见ShowPrivateProviderMetadataResponseBody,如果想查看私有provider下全部provider版本,请调用ListPrivateProviderVersion - [更新私有provider元数据](https://support.huaweicloud.com/api-aos/UpdatePrivateProviderMetadata.md): 更新私有provider元数据(UpdatePrivateProviderMetadata)更新当前私有provider的元数据信息目前只支持更新私有provider的描述目前只支持更新私有provider的描述如果需要创建新的版本,请调用CreatePrivateProviderVersion如果需要创建新的版本,请调用CreatePr - [删除私有provider版本](https://support.huaweicloud.com/api-aos/DeletePrivateProviderVersion.md): 删除私有provider版本(DeletePrivateProviderVersion)删除某个私有provider版本如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配 - [获取私有provider版本元数据](https://support.huaweicloud.com/api-aos/ShowPrivateProviderVersionMetadata.md): 获取私有provider版本元数据(ShowPrivateProviderVersionMetadata)获取某个私有provider版本的元数据信息具体返回信息见ShowPrivateProviderVersionMetadataResponseBody具体返回信息见ShowPrivateProviderVersionMetadataR - [创建私有hook](https://support.huaweicloud.com/api-aos/CreatePrivateHook.md): 创建私有hook(CreatePrivateHook)创建一个带有初始默认版本的私有hook,创建私有hook的时候需要同时创建一个初始化的默认版本,不允许空私有hook的创建。设置配置(Configuration)后的私有hook才会在触发资源栈部署时生效,资源栈使用私有hook的默认版本。若创建私有hook时未指定配置项,则该私有ho - [列举私有hook](https://support.huaweicloud.com/api-aos/ListPrivateHooks.md): 列举私有hook(ListPrivateHooks)列举当前局点下用户所有的私有hook。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir的数量须一致,否则返回400。若未给予sort_key和sort_dir,则默认按照创建时间降序排序。 - [删除私有hook](https://support.huaweicloud.com/api-aos/DeletePrivateHook.md): 删除私有hook(DeletePrivateHook)删除某个私有hook以及私有hook下的全部hook版本默认版本只能调用本API删除,除默认版本外的其它版本可以调用DeletePrivateHookVersion API删除。默认版本只能调用本API删除,除默认版本外的其它版本可以调用DeletePrivateHookVersion - [创建私有hook版本](https://support.huaweicloud.com/api-aos/CreatePrivateHookVersion.md): 创建私有hook版本(CreatePrivateHookVersion)创建私有hook版本,创建私有hook版本后需要调用UpdatePrivateHook API设置为默认版本才能生效。版本号遵循语义化版本号(Semantic Version),为用户自定义。其各层级(Major.Minor.Patch)均采用无符号 64 位整型(u - [列举私有hook版本](https://support.huaweicloud.com/api-aos/ListPrivateHookVersions.md): 列举私有hook版本(ListPrivateHookVersions)列举所选择的私有hook中所有的hook版本信息。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir - [删除私有hook版本](https://support.huaweicloud.com/api-aos/DeletePrivateHookVersion.md): 删除私有hook版本(DeletePrivateHookVersion)删除某个私有hook版本默认版本只能调用DeletePrivateHook API删除,除默认版本外的其它版本都可以调用本API删除。默认版本只能调用DeletePrivateHook API删除,除默认版本外的其它版本都可以调用本API删除。若hook_name和h - [获取私有hook版本策略](https://support.huaweicloud.com/api-aos/ShowPrivateHookVersionPolicy.md): 获取私有hook版本策略(ShowPrivateHookVersionPolicy)获取指定私有hook对应版本的策略。如果获取成功,则以临时重定向形式返回私有hook版本策略下载链接(OBS Pre Signed地址,有效期为5分钟),大多数的客户端会进行自动重定向并下载私有hook版本策略。如果获取成功,则以临时重定向形式返回私有ho - [获取私有hook元数据](https://support.huaweicloud.com/api-aos/ShowPrivateHookMetadata.md): 获取私有hook元数据(ShowPrivateHookMetadata)获取某个私有hook的元数据信息具体返回的信息见ShowPrivateHookMetadataResponseBody,若想查看私有hook下全部版本,请调用ListPrivateHookVersions。具体返回的信息见ShowPrivateHookMetadata - [更新私有hook元数据](https://support.huaweicloud.com/api-aos/UpdatePrivateHookMetadata.md): 更新私有hook元数据(UpdatePrivateHookMetadata)更新当前私有hook的元数据信息目前支持更新私有hook的描述、默认版本、配置。目前支持更新私有hook的描述、默认版本、配置。如果需要创建新的版本,请调用CreatePrivateHookVersion。如果需要创建新的版本,请调用CreatePrivateHo - [获取私有hook版本的元数据](https://support.huaweicloud.com/api-aos/ShowPrivateHookVersionMetadata.md): 获取私有hook版本的元数据(ShowPrivateHookVersionMetadata)获取当前私有hook对应版本的元数据信息具体返回的信息见ShowPrivateHookVersionMetadataResponseBody。具体返回的信息见ShowPrivateHookVersionMetadataResponseBody。如果 - [创建私有模块](https://support.huaweicloud.com/api-aos/CreatePrivateModule.md): 创建私有模块(CreatePrivateModule)创建一个空的私有模块。如果用户给予了module_version与module_uri,则在创建私有模块的同时,在私有模块下创建一个私有模块版本。模块允许用户将可复用的代码编辑在一起供模块使用。模块允许用户将可复用的代码编辑在一起供模块使用。如果同名私有模块在当前账户中已经存在,则会返 - [列举私有模块](https://support.huaweicloud.com/api-aos/ListPrivateModules.md): 列举私有模块(ListPrivateModules)列举当前局点下用户所有的私有模块。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir,则默认按照创建时间降序排序。可以 - [删除私有模块](https://support.huaweicloud.com/api-aos/DeletePrivateModule.md): 删除私有模块(DeletePrivateModule)删除某个私有模块以及私有模块下的全部模块版本如果module_name和module_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。如果module_name和module_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。请谨慎操作 - [获取私有模块元数据](https://support.huaweicloud.com/api-aos/ShowPrivateModuleMetadata.md): 获取私有模块元数据(ShowPrivateModuleMetadata)获取当前私有模块的元数据信息具体返回的信息见ShowPrivateModuleMetadataResponseBody,如果想查看私有模块下全部模块版本,请调用ListPrivateModuleVersions。具体返回的信息见ShowPrivateModuleMet - [更新私有模块元数据](https://support.huaweicloud.com/api-aos/UpdatePrivateModuleMetadata.md): 更新私有模块元数据(UpdatePrivateModuleMetadata)更新当前私有模块的元数据信息目前只支持更新私有模块的描述目前只支持更新私有模块的描述如果需要创建新的版本,请调用CreatePrivateModuleVersion如果需要创建新的版本,请调用CreatePrivateModuleVersion更新为增量更新,即如 - [创建私有模块版本](https://support.huaweicloud.com/api-aos/CreatePrivateModuleVersion.md): 创建私有模块版本(CreatePrivateModuleVersion)创建新的私有模块版本版本号遵循语义化版本(Semantic Versioning)规范,支持用户自定义。其各层级(Major.Minor.Patch)均采用无符号 64 位整型(uint64)。版本号遵循语义化版本(Semantic Versioning)规范,支持用 - [列举私有模块版本](https://support.huaweicloud.com/api-aos/ListPrivateModuleVersions.md): 列举私有模块版本(ListPrivateModuleVersions)列举所选择的私有模块中所有的模块版本信息。可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir,则默认 - [获取私有模块版本内容](https://support.huaweicloud.com/api-aos/ShowPrivateModuleVersionContent.md): 获取私有模块版本内容(ShowPrivateModuleVersionContent)获取指定私有模块对应版本的内容。如果获取成功,则以临时重定向形式返回模块下载链接(OBS Pre Signed地址,有效期为5分钟),大多数的客户端会进行自动重定向并下载模块;如果获取成功,则以临时重定向形式返回模块下载链接(OBS Pre Signed - [删除私有模块版本](https://support.huaweicloud.com/api-aos/DeletePrivateModuleVersion.md): 删除私有模块版本(DeletePrivateModuleVersion)删除某个私有模块版本如果module_name和module_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。如果module_name和module_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。请谨慎操作您可以 - [获取私有模块版本元数据](https://support.huaweicloud.com/api-aos/ShowPrivateModuleVersionMetadata.md): 获取私有模块版本元数据(ShowPrivateModuleVersionMetadata)获取当前私有模块对应的版本的元数据信息具体返回的信息见ShowPrivateModuleVersionMetadataResponseBody。具体返回的信息见ShowPrivateModuleVersionMetadataResponseBody。 - [权限和授权项](https://support.huaweicloud.com/api-aos/rfs_02_0327.md): 如果您需要对您所拥有的资源编排服务(RFS)进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),如果帐号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用RFS服务的其它功能。默认情况下,新建的IAM用户没有任何权限,您需要将其加入用户组, - [状态码](https://support.huaweicloud.com/api-aos/aos_02_0041.md): 状态码如表1所示。 - [错误码](https://support.huaweicloud.com/api-aos/ErrorCode.md): 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。更多服务错误码请参见API错误中心。 - [获取项目ID](https://support.huaweicloud.com/api-aos/aos_02_0005.md): 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式:调用API获取项目ID从控制台获取项目ID项目ID可以通过调用查询指定条件下的项目列表API获取。获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和 - [获取账号ID](https://support.huaweicloud.com/api-aos/aos_02_0051.md): 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下:登录管理控制台。单击用户名,在下拉列表中单击我的凭证。在API凭证页面查看账号ID。获取账号ID在API凭证页面查看账号ID。 - [修订记录](https://support.huaweicloud.com/api-aos/aos_02_0070.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 ## CLI参考 - [如何使用CLI](https://support.huaweicloud.com/clir-aos/toctopics/zh-cn_topic_0000002706689974.md): 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中资源编排服务(RFS)开放的API,管理和使用资源编排服务(RFS)相关功能。关于KooCLI的详细信息, - [CLI命令参考](https://support.huaweicloud.com/clir-aos/RFS-cli.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 ## 常见问题 - [资源编排如何收费](https://support.huaweicloud.com/aos_faq/rf_03_0001.md): 资源编排本身不收取任何费用,但使用模板创建资源栈时,资源编排会帮助您创建模板指定的云服务资源,创建的云服务资源具体收费以各云服务价格为准,请参见产品价格详情。 - [如何更新资源栈](https://support.huaweicloud.com/aos_faq/rf_03_0002.md): 资源编排支持更新资源栈。更新资源栈需要先修改您的资源栈模板,您可以修改模板中的参数值,或者增加、删除模板中的资源。再通过“更新”资源栈按钮,选择编辑好的新模板即可进行更新资源栈。 - [创建执行计划,创建资源栈,更新资源栈的区别](https://support.huaweicloud.com/aos_faq/rf_03_0003.md): 创建执行计划:生成一个执行计划,通过提前浏览整个计划,可以评估对正在进行的资源造成的影响。创建后不会改变资源栈,只有进行了执行操作时,系统才会对您的资源栈进行更改。创建资源栈:提供初始模板,创建并且部署资源栈。更新资源栈:用户可以提供新的模板、参数等,触发一个新的部署,对资源栈直接进行更改。