华为云用户手册

请求示例 通过vars uri 传递期望更新的覆盖参数，保留资源栈实例中已被覆盖的参数var_key_1，并触发部署，且指定更新资源栈实例在region间串行进行 PATCH https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances { "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids_uri" : "https://your-bucket.cn-north-7.myhuaweicloud.com/my-domain-ids.csv" }, "var_overrides" : { "vars_uri" : "https://{bucket_name}.{region}.myhuaweicloud.com/my-hello-world-vars.tfvars", "use_stack_set_vars" : [ "var_key_1" ] }, "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "operation_preferences" : { "region_concurrency_type" : "SEQUENTIAL" } } 部署在cn-north-7下租户ID为my-domain-id的资源栈实例，不更新参数覆盖，且指定更新资源栈实例在region间并行进行 PATCH https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances { "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids" : [ "my-domain-id" ] }, "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "operation_preferences" : { "region_concurrency_type" : "PARALLEL" } }

响应参数 状态码： 202 表7 响应Body参数 参数 参数类型 描述 stack_set_operation_id String 资源栈集操作（stack_set_operation）的唯一Id。 此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID。 最小长度：36 最大长度：36 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

功能介绍 更新资源栈实例（UpdateStackInstances） 此API用于更新并部署指定资源栈实例集合，并返回资源栈集操作ID（stack_set_operation_id） 此API可以通过var_overrides参数，更新指定资源栈实例的参数值，进行参数覆盖。如果var_overrides参数未给予，则默认使用当前资源栈集中记录的参数进行部署，详见：var_overrides参数描述。用户只可以更新已经存在的资源栈实例，如果用户想要增加额外的资源栈实例，请使用CreateStackInstances API。 通过DeployStackSet API更新资源栈集参数后，资源栈实例中已经被覆盖的参数不会被更新，仍然保留覆盖值。 用户只能覆盖已经在资源栈集中记录的参数，如果用户想要增加可以覆盖的参数，需要先通过DeployStackSet API更新资源栈集记录的参数集合。 当触发的部署失败时，资源栈实例不会自动回滚参数覆盖，但部署失败的资源栈会默认自动回滚，已经部署成功的资源栈不会触发回滚。 用户可以根据资源栈集操作ID（stack_set_operation_id），通过ShowStackSetOperationMetadata API获取资源栈集操作状态。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 stack_set_id 否 String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，在重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是又其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 最小长度：36 最大长度：36 deployment_targets 是 deployment_targets object 部署目标信息。 var_overrides 否 var_overrides object 用户期望在资源栈实例中更新的参数内容，参数将覆盖到本次请求中指定的所有资源栈实例中，并根据更新后的参数部署资源栈实例。覆盖后的参数将永久被记录在资源栈实例中，并在之后的部署中继续使用被覆盖参数，直到下一次被更新覆盖。 用户只能覆盖在资源栈集中记录的参数集合vars，如果指定了vars中不存在的参数会报错400。如果用户想要增加可以覆盖的参数，需要先通过DeployStackSet API 更新资源栈集记录的参数集合vars。通过DeployStackSet API更新vars后，资源栈实例中已经被覆盖的参数不会被更新，仍然保留覆盖值。 参数覆盖只针对用户在资源栈集中通过vars指定的参数，不包括在模板中定义使用默认值的参数。如果用户期望对使用默认值的参数进行覆盖，则需要按上述要求先通过DeployStackSet API 更新资源栈集记录的vars，显式地向vars中增加相关参数定义。 用户每次通过DeployStackSet API 更新资源栈集vars时，如果缺少了任一部署目标的资源栈实例中所记录的被覆盖参数时（即当前被覆盖参数已不是更新后资源栈集参数vars的子集)，会报错400 当前用户在更新参数覆盖时不能指定保留已有的参数覆盖，必须在更新的时候给予全部的覆盖信息。 参数覆盖后的资源栈实例应用的vars_body总长不超过51200。参数覆盖后的资源栈实例应用的vars_uri文件内容不超过1M。 例如：资源栈集中记录的vars_body内容为”key1=value1,key2=value2,....“，资源栈实例参数覆盖的vars_body为“key1=another_value1”，则要求应用参数覆盖后的vars_body“key1=another_value1,key2=value2,....”总长不超过51200。 例如：资源栈集中记录的vars_uri文件内容为”key1=value1,key2=value2,....“，资源栈实例参数覆盖的vars_body为“key1=another_value1”，则要求应用参数覆盖后的vars_uri文件内容“key1=another_value1,key2=value2,....”总长不超过1M。 如果var_overrides未给予，则不会更新覆盖资源栈实例中记录的参数。如果vars_uri或vars_body或use_stack_set_vars至少给予了一个，则会对参数覆盖进行替换式更新，即所给予的参数将被完全覆盖至指定资源栈实例中。 vars_body、vars_uri和use_stack_set_vars中声明的全部参数集合必须和资源栈集中记录的参数集合保持一致，如果声明了资源栈集中不存在的参数会报错400，如果没有声明已经在资源栈集中记录的参数会报错400，如果声名了同一个参数会报错400。 注： 期望覆盖指定参数值，需要在vars_uri或者vars_body中指定期望覆盖的参数名称及参数值。 期望将某个已覆盖参数回退至资源栈集中记录的参数值，需要在use_stack_set_vars中指定期望回退的参数名称。 期望将所有已覆盖参数回退至资源栈集中记录的参数值，需要在use_stack_set_vars中指定资源栈集中记录的全部参数名称。 期望使用当前资源栈实例中记录的参数值进行部署，则不需要指定var_overrides。 operation_preferences 否 operation_preferences object 资源栈集操作（stack_set_operation）的部署策略。该参数只在指定的单次操作中生效。 当用户不指定该参数时，默认的操作部署策略为区域（region）内资源栈实例串行部署，即每次只执行一个资源栈实例，区域（region）间随机且串行部署，执行完一个region下的全部资源栈实例后，才会选择另一个region部署，容错次数默认为0。 该参数可以在生成资源栈集操作的四个API中指定： 创建资源栈实例（CreateStackInstance），部署资源栈集（DeployStackSet），更新资源栈实例（UpdateStackInstance），删除资源栈实例（DeleteStackInstance） 表4 deployment_targets 参数 是否必选 参数类型 描述 regions 是 Array of strings 用户指定资源栈集操作所涉及的区域。 在DeployStackSet API中，根据用户输入regions和domain_ids列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的region，则会报错。 domain_ids 否 Array of strings 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids列表和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri 有且仅有一个存在。 最小长度：1 最大长度：64 domain_ids_uri 否 String 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容文件的OBS地址。 内容格式要求每个租户ID以逗号（,）分割，支持换行。当前仅支持csv文件，且文件的编码格式须为UTF-8。文件内容大小不超过100KB。 上传的csv文件应尽量避免Excel操作，以防出现读取内容不一致的问题。推荐使用记事本打开确认内容是否符合预期。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids_uri文件内容和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果内容包含了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri有且仅有一个存在。 最小长度：0 最大长度：2048 表5 var_overrides 参数 是否必选 参数类型 描述 vars_uri 否 String HCL参数文件的OBS地址。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 OBS地址支持同类型Region之间进行互相访问（Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region） vars_uri需要指向一个OBS的pre-signed URL地址，其他地址暂不支持 资源编排服务支持vars_body和vars_uri，如果以上两种方式中声名了同一个变量，将报错400 vars_uri中的内容使用HCL的tfvars格式，用户可以将“.tfvars”中的内容保存到文件并上传到OBS中，并将OBS pre-signed URL传递给vars_uri 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储vars_uri对应的参数文件内容 最小长度：0 最大长度：2048 vars_body 否 String HCL参数文件的内容。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 vars_body使用HCL的tfvars格式，用户可以将“.tfvars”中的内容提交到vars_body中 资源编排服务支持vars_body和vars_uri，如果以上两种方式中声名了同一个变量，将报错400 如果vars_body过大，可以使用vars_uri 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储对应的vars_body。 最小长度：0 最大长度：51200 use_stack_set_vars 否 Array of strings 用户期望使用资源栈集中记录的参数值进行部署的参数名称列表。 用户只能选择已经在资源栈集中被记录的参数，如果指定了未被记录的参数会报错400。 如果use_stack_set_vars中包含资源栈实例中已经被覆盖的参数名称，则会将该参数回退至资源栈集中记录的参数值。 表6 operation_preferences 参数 是否必选 参数类型 描述 region_concurrency_type 否 String 部署资源栈实例时区域（region）的执行策略，分为两种，SEQUENTIAL和PARALLEL，区分大小写，默认值为SEQUENTIAL 详细介绍： SEQUENTIAL：顺序执行，执行完一个region下的全部资源栈实例后再去执行另一个region。默认顺序执行。 PARALLEL：并发执行，并发部署所有指定区域的资源栈实例。 缺省值：SEQUENTIAL 枚举值： SEQUENTIAL PARALLEL region_order 否 Array of strings 区域（region）部署顺序。只有当用户指定region_concurrency_type为SEQUENTIAL时才会允许指定该参数。用户指定部署region的顺序，不允许出现资源栈集管理之外的region。 如果不指定，实际部署region顺序随机。部署顺序仅在当次部署时生效，应该包含且仅包含本次部署的所有region。 failure_tolerance_count 否 Long 容错次数。用户定义在每个区域（region）下，允许部署失败的资源栈实例数量。该参数取值默认为0，限定0和正整数。 如果定义region顺序执行（region_concurrency_type值为SEQUENTIAL），在某个region超过容错次数时，资源栈集会取消所有状态仍处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE； 如果是region并行执行（region_concurrency_type值为PARALLEL），在某个region超过容错次数时，资源栈集只会取消该region下所有处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE。 对处于OPERATION_IN_PROGRESS，或已经部署完成，即处于OPERATION_COMPLETE或者OPERATION_FAILED状态的资源栈实例，不受影响，状态不变。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 failure_tolerance_percentage 否 Long 容错百分比。定义每个区域（region）下，允许部署失败的资源栈实例数占该region下所有资源栈实例数的百分比。该参数取值默认为0，限定0和正整数。 通过容错百分比*资源栈实例数，并向下取整，得到实际容错次数。 当concurrency_mode指定为STRICT_FAILURE_TOLERANCE时，实际最大并发账户数最多比实际容错次数多1。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 max_concurrent_count 否 Long 每个区域（region）下可同时部署资源栈实例的最大账户数。该参数取值默认为1，限定为正整数。 最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：5 max_concurrent_percentage 否 Long 最大并发账户百分比，每个区域（region）中可同时部署的资源栈实例的最大账户百分比。该参数取值默认为1，限定正整数。 RFS根据百分比 *（每个region下资源栈实例数）得到的值，再向下取整，得到实际最大并发账户数。如果实际最大并发账户数向下取整值为0时，则默认选择最大并发账户数为1。 通过百分比计算得到的实际最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，实际最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：100 failure_tolerance_mode 否 String 资源栈集操作部署的失败容忍模式，分为两种，STRICT_FAILURE_TOLERANCE和SOFT_FAILURE_TOLERANCE，区分大小写，默认值为STRICT_FAILURE_TOLERANCE。 详细介绍： STRICT_FAILURE_TOLERANCE：此选项会动态降低并发级别，以确保同region下部署失败的账户数量永远不超过 failure_tolerance_count + 1。当用户指定failure_tolerance_percentage时，确保同region下部署失败的账户数量不超过 failure_tolerance_percentage * 资源栈实例数 + 1。 初始实际最大并发数为max_concurrent_count，如果用户指定的是max_concurrent_percentage，则初始实际最大并发数为 max_concurrent_percentage * 资源栈实例数，随后，实际最大并发数会根据失败次数增加而减少。 SOFT_FAILURE_TOLERANCE：此选项将failure_tolerance_count与实际并发数分离开。该参数允许资源栈集操作始终以指定的 max_concurrent_count 或 max_concurrent_percentage 操作资源栈实例。 此时不保证资源栈实例失败总数小于 failure_tolerance_count + 1，如果用户指定的是failure_tolerance_percentage的值，则部署失败次数不会超过 failure_tolerance_percentage * 资源栈实例数 + 1。 缺省值：STRICT_FAILURE_TOLERANCE 枚举值： STRICT_FAILURE_TOLERANCE SOFT_FAILURE_TOLERANCE

请求示例 删除指定模板版本 DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions/V1 删除指定模板版本，并提供模板id以校验是否与当前模板匹配 DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions/V1?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3

功能介绍 删除模板版本（DeleteTemplateVersion） 此API用于删除某个模板版本 template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成，为UUID。由于模板名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的模板，删除，再重新创建一个同名模板。对于团队并行开发，用户可能希望确保，当前我操作的模板就是我认为的那个，而不是其他队友删除后创建的同名模板。因此，使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同，更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致，则返回400 如果模板下只存在唯一模板版本，此模板版本将无法被删除，如果需要删除此模板版本，请调用DeleteTemplate。模板服务不允许存在没有模板版本的模板 请谨慎操作

URI DELETE /v1/{project_id}/templates/{template_name}/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，可以从调用API处获取，也可以从控制台获取。 项目ID获取方式 最小长度：3 最大长度：64 template_name 是 String 用户希望创建的模板名称 最小长度：1 最大长度：128 version_id 是 String 模板版本ID，以大写V开头，每次创建模板版本，模板版本ID数字部分会自增加一 最小长度：2 最大长度：11 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 String 模板的ID。当template_id存在时，模板服务会检查template_id是否和template_name匹配，不匹配会返回400 最小长度：36 最大长度：36

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 429 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 列举模板成功 { "templates" : [ { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8", "template_name" : "my_first_template", "template_description" : "模板描述", "create_time" : "2023-05-09T08:00:00Z", "update_time" : "2023-05-09T09:00:00Z", "latest_version_description" : "最新版本描述", "latest_version_id" : "V10" }, { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c9", "template_name" : "my_second_template", "template_description" : "模板描述", "create_time" : "2023-05-09T09:00:00Z", "update_time" : "2023-05-09T10:00:00Z", "latest_version_description" : "最新版本描述", "latest_version_id" : "V10" } ] }

功能介绍 列举模板（ListTemplates） 此API用于列举当前局点下用户所有的模板 默认按照生成时间降序排序，最新生成的模板排列在最前面 注意：目前返回全量模板信息，即不支持分页 如果没有任何模板，则返回空list 如果用户需要详细的模板版本信息，请调用ListTemplateVersions ListTemplates返回的信息只包含模板摘要信息（具体摘要信息见ListTemplatesResponseBody），如果用户需要详细的某个模板信息，请调用ShowTemplateMetadata

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 templates Array of Template objects 模板列表 数组长度：0 - 100 表4 Template 参数 参数类型 描述 template_id String 模板的唯一ID，由模板服务随机生成 最小长度：36 最大长度：36 template_name String 用户希望创建的模板名称 最小长度：1 最大长度：128 template_description String 模板的描述。可用于客户识别自己的模板 最小长度：0 最大长度：1024 create_time String 模板的生成时间，格式遵循RFC3339，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z update_time String 模板的更新时间，格式遵循RFC3339，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z latest_version_id String 模板中最新的模板版本ID 最小长度：2 最大长度：11 latest_version_description String 模板中最新模板版本的版本描述 最小长度：0 最大长度：1024 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 429 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 获取资源栈集模板 GET https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/templates 获取资源栈集模板，并提供资源栈集id以校验是否与当前资源栈集匹配 GET https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/templates?stack_set_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2

URI GET /v1/stack-sets/{stack_set_name}/templates 表1 路径参数 参数 是否必选 参数类型 描述 stack_set_name 是 String 资源栈集的名称。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 stack_set_id 否 String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，再重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我认为的那个，而不是其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 最小长度：36 最大长度：36

响应参数 状态码： 307 表4 响应Header参数 参数 参数类型 描述 Location String HTTP重定向指定头域，客户端可通过此头域重定向至新地址。其内容为模板下载链接，为OBS Pre Signed地址，有效期为5分钟 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 stack_set_id String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，在重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是又其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 最小长度：36 最大长度：36 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 409 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

请求示例 通过OBS Signed URL传递模板和管理委托名称创建资源栈集 POST https://{endpoint}/v1/stack-sets { "stack_set_name" : "my_first_stack_set", "template_uri" : "https://my_hello_world_bucket.{region}.myhuaweicloud.com/vpc.tf", "managed_agency_name" : "my_managed_agency_name", "administration_agency_name" : "my_administration_agency_name" } 通过模板内容和管理委托URN创建资源栈集 POST https://{endpoint}/v1/stack-sets { "stack_set_name" : "my_second_stack_set", "managed_agency_name" : "my_managed_agency_name", "administration_agency_urn" : "iam::my-domain-id:agency:my-agency-name", "template_body" : "terraform {\n required_providers {\n huaweicloud = {\n source = \"huawei.com/provider/huaweicloud\"\n version = \"1.41.0\"\n }\n }\n}\nprovider \"huaweicloud\"{\n insecure = true\n cloud = \"{cloud_name}\"\n region = \"{region}\"\n endpoints = {\n iam = \"{iam_endpoint}\",\n }\n}\n\nresource \"huaweicloud_vpc\" \"vpc\" {\n cidr = \"172.16.0.0/16\"\n name = \"my_vpc\"\n}" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表2 请求Body参数 参数 是否必选 参数类型 描述 stack_set_name 是 String 资源栈集（stack_set）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128 stack_set_description 否 String 资源栈集的描述。可用于客户识别自己的资源栈集。 最小长度：0 最大长度：1024 permission_model 否 String 权限模型，定义了RFS操作资源栈集时所需委托的创建方式，枚举值 SELF_MANAGED - 基于部署需求，用户需要提前手动创建委托，既包含管理账号给RFS的委托，也包含成员账号创建给管理账号的委托。如果委托不存在或错误，创建资源栈集不会失败，部署资源栈集或部署资源栈实例的时候才会报错。 缺省值：SELF_MANAGED 枚举值： SELF_MANAGED administration_agency_name 否 String 管理委托名称 资源编排服务使用该委托获取成员账号委托给管理账号的权限。该委托中必须含有iam:tokens:assume权限，用以后续获取被管理委托凭证。如果不包含，则会在新增或者部署实例时报错。 当用户定义SELF_MANAGED权限类型时，administration_agency_name和administration_agency_urn 必须有且只有一个存在。 推荐用户在使用信任委托时给予administration_agency_urn，administration_agency_name只支持接收委托名称，如果给予了信任委托名称，则会在部署模板时失败。 当用户使用SERVICE_MANAGED权限类型时，指定该参数将报错400。 创建委托及授权方式 最小长度：0 最大长度：64 managed_agency_name 否 String 被管理的委托名称。 资源编排服务会使用该委托获取实际部署资源所需要的权限 不同成员账号委托给管理账号的委托名称需要保持一致。暂不支持根据不同provider定义不同委托权限 当用户定义SELF_MANAGED权限类型时，必须指定该参数。当用户使用SERVICE_MANAGED权限类型时，指定该参数将报错400 创建委托及授权方式 最小长度：0 最大长度：64 template_body 否 String HCL模板，描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 注意： 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储对应的template_body 最小长度：0 最大长度：51200 template_uri 否 String HCL模板的OBS地址，该模板描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别 OBS地址支持同类型Region之间进行互相访问（Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region） 对应的文件应该是纯tf文件或zip压缩包 纯tf文件需要以“.tf”或者“.tf.json”结尾，并遵守HCL语法，且文件的编码格式须为UTF-8 压缩包目前只支持zip格式，文件需要以".zip"结尾。解压后的文件不得包含".tfvars"文件。解压前最大支持1MB，解压后最大支持1MB。zip压缩包文件数量不能超过100个 template_body和template_uri 必须有且只有一个存在 注意： 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储template_uri对应的模板文件内容。 template_uri对应的模板文件如果为zip类型，则内部的文件或文件夹名称长度不得超过255个字节，最深路径长度不得超过2048字节，zip包大小不得超过1MB 最小长度：0 最大长度：2048 vars_uri 否 String HCL参数文件的OBS地址。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 OBS地址支持同类型Region之间进行互相访问（Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region） vars_uri需要指向一个OBS的pre-signed URL地址，其他地址暂不支持 资源编排服务支持vars_body和vars_uri，如果以上两种方式中声名了同一个变量，将报错400 vars_uri中的内容使用HCL的tfvars格式，用户可以将“.tfvars”中的内容保存到文件并上传到OBS中，并将OBS pre-signed URL传递给vars_uri 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储vars_uri对应的参数文件内容 最小长度：0 最大长度：2048 vars_body 否 String HCL参数文件的内容。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 vars_body使用HCL的tfvars格式，用户可以将“.tfvars”中的内容提交到vars_body中 资源编排服务支持vars_body和vars_uri，如果以上两种方式中声名了同一个变量，将报错400 如果vars_body过大，可以使用vars_uri 资源栈集不支持敏感数据加密，资源编排服务会直接明文使用、log、展示、存储对应的vars_body。 最小长度：0 最大长度：51200 initial_stack_description 否 String 初始化资源栈描述。可用于客户识别被资源栈集所管理的资源栈。 资源栈集下的资源栈仅在创建时统一使用该描述。客户想要更新初始化资源栈描述，可以通过UpdateStackSet API。 后续更新资源栈集描述将不会同步更新已管理的资源栈描述。 最小长度：0 最大长度：1024 administration_agency_urn 否 String 管理委托URN 资源编排服务使用该委托获取成员账号委托给管理账号的权限。该委托中必须含有sts:tokens:assume权限，用以后续获取被管理委托凭证。如果不包含，则会在新增或者部署实例时报错。 当用户定义SELF_MANAGED权限类型时，administration_agency_name和administration_agency_urn 必须有且只有一个存在。 推荐用户在使用信任委托时给予administration_agency_urn，administration_agency_name只支持接收委托名称，如果给予了信任委托名称，则会在部署模板时失败。 当用户使用SERVICE_MANAGED权限类型时，指定该参数将报错400。 managed_operation 否 managed_operation object 用于定义管理资源栈集操作的一系列属性。 表3 managed_operation 参数 是否必选 参数类型 描述 enable_parallel_operation 否 Boolean 资源栈集（stack_set）是否可以并发地创建多个资源栈集操作。该参数作为资源栈集属性，可以通过创建资源栈集API（CreateStackSet）指定，通过更新资源栈集API（UpdateStackSet）更新该参数。 该参数默认为false，资源栈集只允许以串行的方式生成并执行资源栈集操作。同一时刻，资源栈集中只会存在一个处于运行态，即QUEUE_IN_PROGRESS或OPERATION_IN_PROGRESS状态的资源栈集操作，该操作执行完成后，下一个资源栈集操作才允许被创建。 该参数如果设定为true，资源栈集允许并发地生成多个资源栈集操作，执行非冲突操作，并将冲突操作进行排队处理。当冲突操作执行完毕，资源栈集按请求顺序继续执行排队操作。 注：冲突操作指资源栈集允许多个操作同时执行的条件下，如果超过一个以上的操作包含了同一资源栈实例，此时在该资源栈实例上的多个操作被称为冲突操作。 当资源栈集状态为OPERATION_IN_PROGRESS时，不允许用户通过更新资源栈集（UpdateStackSet）来更新该参数。 当前，一个资源栈集下仅允许同时最多存在10个处于运行态的资源栈集操作*

请求示例 通过Domain Ids Signed URL传递成员账户信息，且指定删除资源栈实例在region间串行进行 DELETE https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids_uri" : "https://your-bucket.cn-north-7.myhuaweicloud.com/my-domain-ids.csv" }, "operation_preferences" : { "region_concurrency_type" : "SEQUENTIAL" } } 通过Domain Ids Array传递成员账户信息，且指定删除资源栈实例在region间并行进行 DELETE https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids" : [ "0e0bc7572c0dfb74efa6c60ecd7b1dbf" ] }, "operation_preferences" : { "region_concurrency_type" : "PARALLEL" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 stack_set_id 否 String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，在重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是又其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 最小长度：36 最大长度：36 deployment_targets 是 deployment_targets object 部署目标信息。 operation_preferences 否 operation_preferences object 资源栈集操作（stack_set_operation）的部署策略。该参数只在指定的单次操作中生效。 当用户不指定该参数时，默认的操作部署策略为区域（region）内资源栈实例串行部署，即每次只执行一个资源栈实例，区域（region）间随机且串行部署，执行完一个region下的全部资源栈实例后，才会选择另一个region部署，容错次数默认为0。 该参数可以在生成资源栈集操作的四个API中指定： 创建资源栈实例（CreateStackInstance），部署资源栈集（DeployStackSet），更新资源栈实例（UpdateStackInstance），删除资源栈实例（DeleteStackInstance） 表4 deployment_targets 参数 是否必选 参数类型 描述 regions 是 Array of strings 用户指定资源栈集操作所涉及的区域。 在DeployStackSet API中，根据用户输入regions和domain_ids列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的region，则会报错。 domain_ids 否 Array of strings 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids列表和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri 有且仅有一个存在。 最小长度：1 最大长度：64 domain_ids_uri 否 String 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容文件的OBS地址。 内容格式要求每个租户ID以逗号（,）分割，支持换行。当前仅支持csv文件，且文件的编码格式须为UTF-8。文件内容大小不超过100KB。 上传的csv文件应尽量避免Excel操作，以防出现读取内容不一致的问题。推荐使用记事本打开确认内容是否符合预期。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids_uri文件内容和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果内容包含了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri有且仅有一个存在。 最小长度：0 最大长度：2048 表5 operation_preferences 参数 是否必选 参数类型 描述 region_concurrency_type 否 String 部署资源栈实例时区域（region）的执行策略，分为两种，SEQUENTIAL和PARALLEL，区分大小写，默认值为SEQUENTIAL 详细介绍： SEQUENTIAL：顺序执行，执行完一个region下的全部资源栈实例后再去执行另一个region。默认顺序执行。 PARALLEL：并发执行，并发部署所有指定区域的资源栈实例。 缺省值：SEQUENTIAL 枚举值： SEQUENTIAL PARALLEL region_order 否 Array of strings 区域（region）部署顺序。只有当用户指定region_concurrency_type为SEQUENTIAL时才会允许指定该参数。用户指定部署region的顺序，不允许出现资源栈集管理之外的region。 如果不指定，实际部署region顺序随机。部署顺序仅在当次部署时生效，应该包含且仅包含本次部署的所有region。 failure_tolerance_count 否 Long 容错次数。用户定义在每个区域（region）下，允许部署失败的资源栈实例数量。该参数取值默认为0，限定0和正整数。 如果定义region顺序执行（region_concurrency_type值为SEQUENTIAL），在某个region超过容错次数时，资源栈集会取消所有状态仍处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE； 如果是region并行执行（region_concurrency_type值为PARALLEL），在某个region超过容错次数时，资源栈集只会取消该region下所有处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE。 对处于OPERATION_IN_PROGRESS，或已经部署完成，即处于OPERATION_COMPLETE或者OPERATION_FAILED状态的资源栈实例，不受影响，状态不变。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 failure_tolerance_percentage 否 Long 容错百分比。定义每个区域（region）下，允许部署失败的资源栈实例数占该region下所有资源栈实例数的百分比。该参数取值默认为0，限定0和正整数。 通过容错百分比*资源栈实例数，并向下取整，得到实际容错次数。 当concurrency_mode指定为STRICT_FAILURE_TOLERANCE时，实际最大并发账户数最多比实际容错次数多1。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 max_concurrent_count 否 Long 每个区域（region）下可同时部署资源栈实例的最大账户数。该参数取值默认为1，限定为正整数。 最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：5 max_concurrent_percentage 否 Long 最大并发账户百分比，每个区域（region）中可同时部署的资源栈实例的最大账户百分比。该参数取值默认为1，限定正整数。 RFS根据百分比 *（每个region下资源栈实例数）得到的值，再向下取整，得到实际最大并发账户数。如果实际最大并发账户数向下取整值为0时，则默认选择最大并发账户数为1。 通过百分比计算得到的实际最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，实际最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：100 failure_tolerance_mode 否 String 资源栈集操作部署的失败容忍模式，分为两种，STRICT_FAILURE_TOLERANCE和SOFT_FAILURE_TOLERANCE，区分大小写，默认值为STRICT_FAILURE_TOLERANCE。 详细介绍： STRICT_FAILURE_TOLERANCE：此选项会动态降低并发级别，以确保同region下部署失败的账户数量永远不超过 failure_tolerance_count + 1。当用户指定failure_tolerance_percentage时，确保同region下部署失败的账户数量不超过 failure_tolerance_percentage * 资源栈实例数 + 1。 初始实际最大并发数为max_concurrent_count，如果用户指定的是max_concurrent_percentage，则初始实际最大并发数为 max_concurrent_percentage * 资源栈实例数，随后，实际最大并发数会根据失败次数增加而减少。 SOFT_FAILURE_TOLERANCE：此选项将failure_tolerance_count与实际并发数分离开。该参数允许资源栈集操作始终以指定的 max_concurrent_count 或 max_concurrent_percentage 操作资源栈实例。 此时不保证资源栈实例失败总数小于 failure_tolerance_count + 1，如果用户指定的是failure_tolerance_percentage的值，则部署失败次数不会超过 failure_tolerance_percentage * 资源栈实例数 + 1。 缺省值：STRICT_FAILURE_TOLERANCE 枚举值： STRICT_FAILURE_TOLERANCE SOFT_FAILURE_TOLERANCE

响应参数 状态码： 202 表6 响应Body参数 参数 参数类型 描述 stack_set_operation_id String 资源栈集操作（stack_set_operation）的唯一Id。 此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID。 最小长度：36 最大长度：36 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

功能介绍 删除资源栈实例-被废弃（DeleteStackInstanceDeprecated） 此API用于删除指定资源栈集下指定局点（region）或指定成员账户（domain_id）的资源栈实例，并返回资源栈集操作ID（stack_set_operation_id） 请谨慎操作，删除资源栈实例将会删除与该资源栈实例相关的堆栈以及堆栈所管理的一切资源。 用户可以根据资源栈集操作ID（stack_set_operation_id），通过ShowStackSetOperationMetadata API获取资源栈集操作状态

响应参数 状态码： 202 表6 响应Body参数 参数 参数类型 描述 stack_set_operation_id String 资源栈集操作（stack_set_operation）的唯一Id。 此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID。 最小长度：36 最大长度：36 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

请求示例 通过Domain Ids Signed URL传递成员账户信息，且指定删除资源栈实例在region间串行进行 POST https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances/deletion { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids_uri" : "https://your-bucket.cn-north-7.myhuaweicloud.com/my-domain-ids.csv" }, "operation_preferences" : { "region_concurrency_type" : "SEQUENTIAL" } } 通过Domain Ids Array传递成员账户信息，且指定删除资源栈实例在region间并行进行 POST https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances/deletion { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids" : [ "0e0bc7572c0dfb74efa6c60ecd7b1dbf" ] }, "operation_preferences" : { "region_concurrency_type" : "PARALLEL" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 stack_set_id 否 String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，在重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是又其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 最小长度：36 最大长度：36 deployment_targets 是 deployment_targets object 部署目标信息。 operation_preferences 否 operation_preferences object 资源栈集操作（stack_set_operation）的部署策略。该参数只在指定的单次操作中生效。 当用户不指定该参数时，默认的操作部署策略为区域（region）内资源栈实例串行部署，即每次只执行一个资源栈实例，区域（region）间随机且串行部署，执行完一个region下的全部资源栈实例后，才会选择另一个region部署，容错次数默认为0。 该参数可以在生成资源栈集操作的四个API中指定： 创建资源栈实例（CreateStackInstance），部署资源栈集（DeployStackSet），更新资源栈实例（UpdateStackInstance），删除资源栈实例（DeleteStackInstance） 表4 deployment_targets 参数 是否必选 参数类型 描述 regions 是 Array of strings 用户指定资源栈集操作所涉及的区域。 在DeployStackSet API中，根据用户输入regions和domain_ids列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的region，则会报错。 domain_ids 否 Array of strings 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids列表和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果指定了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri 有且仅有一个存在。 最小长度：1 最大长度：64 domain_ids_uri 否 String 权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容文件的OBS地址。 内容格式要求每个租户ID以逗号（,）分割，支持换行。当前仅支持csv文件，且文件的编码格式须为UTF-8。文件内容大小不超过100KB。 上传的csv文件应尽量避免Excel操作，以防出现读取内容不一致的问题。推荐使用记事本打开确认内容是否符合预期。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids_uri文件内容和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果内容包含了没有被资源栈集所管理的domain_id，则会报错。 domain_ids和domain_ids_uri有且仅有一个存在。 最小长度：0 最大长度：2048 表5 operation_preferences 参数 是否必选 参数类型 描述 region_concurrency_type 否 String 部署资源栈实例时区域（region）的执行策略，分为两种，SEQUENTIAL和PARALLEL，区分大小写，默认值为SEQUENTIAL 详细介绍： SEQUENTIAL：顺序执行，执行完一个region下的全部资源栈实例后再去执行另一个region。默认顺序执行。 PARALLEL：并发执行，并发部署所有指定区域的资源栈实例。 缺省值：SEQUENTIAL 枚举值： SEQUENTIAL PARALLEL region_order 否 Array of strings 区域（region）部署顺序。只有当用户指定region_concurrency_type为SEQUENTIAL时才会允许指定该参数。用户指定部署region的顺序，不允许出现资源栈集管理之外的region。 如果不指定，实际部署region顺序随机。部署顺序仅在当次部署时生效，应该包含且仅包含本次部署的所有region。 failure_tolerance_count 否 Long 容错次数。用户定义在每个区域（region）下，允许部署失败的资源栈实例数量。该参数取值默认为0，限定0和正整数。 如果定义region顺序执行（region_concurrency_type值为SEQUENTIAL），在某个region超过容错次数时，资源栈集会取消所有状态仍处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE； 如果是region并行执行（region_concurrency_type值为PARALLEL），在某个region超过容错次数时，资源栈集只会取消该region下所有处于WAIT_IN_PROGRESS状态的实例。被取消的实例状态最终变为CANCEL_COMPLETE。 对处于OPERATION_IN_PROGRESS，或已经部署完成，即处于OPERATION_COMPLETE或者OPERATION_FAILED状态的资源栈实例，不受影响，状态不变。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 failure_tolerance_percentage 否 Long 容错百分比。定义每个区域（region）下，允许部署失败的资源栈实例数占该region下所有资源栈实例数的百分比。该参数取值默认为0，限定0和正整数。 通过容错百分比*资源栈实例数，并向下取整，得到实际容错次数。 当concurrency_mode指定为STRICT_FAILURE_TOLERANCE时，实际最大并发账户数最多比实际容错次数多1。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 最小值：0 最大值：100 max_concurrent_count 否 Long 每个区域（region）下可同时部署资源栈实例的最大账户数。该参数取值默认为1，限定为正整数。 最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：5 max_concurrent_percentage 否 Long 最大并发账户百分比，每个区域（region）中可同时部署的资源栈实例的最大账户百分比。该参数取值默认为1，限定正整数。 RFS根据百分比 *（每个region下资源栈实例数）得到的值，再向下取整，得到实际最大并发账户数。如果实际最大并发账户数向下取整值为0时，则默认选择最大并发账户数为1。 通过百分比计算得到的实际最大并发账户数最多比容错次数多1。如果用户指定failure_tolerance_percentage，实际最大并发账户数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 最小值：1 最大值：100 failure_tolerance_mode 否 String 资源栈集操作部署的失败容忍模式，分为两种，STRICT_FAILURE_TOLERANCE和SOFT_FAILURE_TOLERANCE，区分大小写，默认值为STRICT_FAILURE_TOLERANCE。 详细介绍： STRICT_FAILURE_TOLERANCE：此选项会动态降低并发级别，以确保同region下部署失败的账户数量永远不超过 failure_tolerance_count + 1。当用户指定failure_tolerance_percentage时，确保同region下部署失败的账户数量不超过 failure_tolerance_percentage * 资源栈实例数 + 1。 初始实际最大并发数为max_concurrent_count，如果用户指定的是max_concurrent_percentage，则初始实际最大并发数为 max_concurrent_percentage * 资源栈实例数，随后，实际最大并发数会根据失败次数增加而减少。 SOFT_FAILURE_TOLERANCE：此选项将failure_tolerance_count与实际并发数分离开。该参数允许资源栈集操作始终以指定的 max_concurrent_count 或 max_concurrent_percentage 操作资源栈实例。 此时不保证资源栈实例失败总数小于 failure_tolerance_count + 1，如果用户指定的是failure_tolerance_percentage的值，则部署失败次数不会超过 failure_tolerance_percentage * 资源栈实例数 + 1。 缺省值：STRICT_FAILURE_TOLERANCE 枚举值： STRICT_FAILURE_TOLERANCE SOFT_FAILURE_TOLERANCE

功能介绍 删除资源栈实例（DeleteStackInstance） 此API用于删除指定资源栈集下指定局点（region）或指定成员账户（domain_id）的资源栈实例，并返回资源栈集操作ID（stack_set_operation_id） 请谨慎操作，删除资源栈实例将会删除与该资源栈实例相关的堆栈以及堆栈所管理的一切资源。 用户可以根据资源栈集操作ID（stack_set_operation_id），通过ShowStackSetOperationMetadata API获取资源栈集操作状态

URI POST /v1/stack-sets/{stack_set_name}/stack-instances/deletion 表1 路径参数 参数 是否必选 参数类型 描述 stack_set_name 是 String 资源栈集的名称。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128

请求示例 通过OBS Signed URL传递模板和参数信息 POST https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/deployments { "template_uri" : "https://my_hello_world_bucket.{region}.myhuaweicloud.com/my-hello-world-template.tf", "vars_uri" : "https://my_hello_world_bucket.{region}.myhuaweicloud.com/my-hello-world-vars.tfvars", "stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3" }

响应参数 状态码： 202 表7 响应Body参数 参数 参数类型 描述 deployment_id String 部署ID 接受请求，进行异步处理。可以调用GetStackMetadata来获取异步请求的部署状态 注意： 部署资源栈后，资源编排服务持久化请求并立即返回，客户端不等待请求最终处理完成，用户无法实时感知请求处理结果 资源编排服务最终会将异步部署请求排队，在服务端空闲的情况下逐个处理。用户最大等待时长为6小时 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 409 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 template_body 否 String HCL模板，描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 在CreateStack API中，template_body和template_uri可以都不给予 注意： template_body中默认不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的template_body。如为敏感信息，建议将敏感信息通过vars_structure参数化，并设置encryption字段开启加密 最小长度：0 最大长度：51200 template_uri 否 String HCL模板的OBS地址，该模板描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 OBS地址支持同类型Region之间进行互相访问（Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region） 对应的文件应该是纯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 最小长度：0 最大长度：2048 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字段开启加密 数组长度：0 - 100 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字段传递 最小长度：0 最大长度：51200 vars_uri 否 String HCL参数文件的OBS地址。HCL模板支持参数传入，即，同一个模板可以给予不同的参数而达到不同的效果。 OBS地址支持同类型Region之间进行互相访问（Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region） 资源编排服务支持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字段传递 最小长度：0 最大长度：2048 stack_id 否 String 资源栈（stack）的唯一Id。 此Id由资源编排服务在生成资源栈的时候生成，为UUID。 由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400 最小长度：36 最大长度：36 表4 VarsStructure 参数 是否必选 参数类型 描述 var_key 是 String 参数的名字 最小长度：1 最大长度：32 var_value 是 String 参数的值。 注意，参数需要以字符串形式存在，如果是数字，也需要以字符串形式存在，如'10'。 如果需要支持不同类型，或者复杂结构，请使用vars_uri或vars_body 最小长度：0 最大长度：2048 encryption 否 EncryptionStructure object 如果用户传递的var_value是已经加密过的，可以通过声名此项以要求资源编排服务在使用前进行解密，目前暂时只支持KMS加解密 表5 EncryptionStructure 参数 是否必选 参数类型 描述 kms 是 KmsStructure object 如果用户给予的var_value是经过KMS加密的，可以通过传递相关加密信息，资源编排服务在使用的时候会帮助用户进行KMS解密 更多关于KMS加密以及KMS加密的样例代码请见：KMS加密使用场景介绍 注意： 请确保用户给予资源编排服务的委托中包含对指定密钥ID的操作权限 KMS每个月有免费试用的额度，如果超过，则KMS需要收费，此费用不是资源编排服务收取，具体标准见：/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 最小长度：36 最大长度：36 cipher_text 是 String 数据加密密钥所对应的密文 最小长度：2 最大长度：2048

功能介绍 部署资源栈（DeployStack） 此API用于部署一个已有的资源栈 用户可以使用此API更新模板、参数等并触发一个新的部署 此API会直接触发部署，如果用户希望先确认部署会发生的时间，请使用执行计划，即使用CreateExecutionPlan以创建执行计划、使用GetExecutionPlan以获取执行计划 此API为全量API，即用户每次部署都需要给予所想要使用的template、vars的全量 当触发的部署失败时，如果资源栈开启了自动回滚，会触发自动回滚的流程，否则就会停留在部署失败时的状态