文档首页> 资源编排服务 RFS> API参考> 资源编排API> 资源栈集> 删除资源栈实例-已废弃
更新时间：2024-04-19 GMT+08:00
查看PDF
分享

删除资源栈实例-已废弃

功能介绍

删除资源栈实例-被废弃（DeleteStackInstanceDeprecated）

此API用于删除指定资源栈集下指定局点（region）或指定成员账户（domain_id）的资源栈实例，并返回资源栈集操作ID（stack_set_operation_id）

请谨慎操作，删除资源栈实例将会删除与该资源栈实例相关的堆栈以及堆栈所管理的一切资源。

  • 用户可以根据资源栈集操作ID（stack_set_operation_id），通过ShowStackSetOperationMetadata API获取资源栈集操作状态

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

DELETE /v1/stack-sets/{stack_set_name}/stack-instances

表1 路径参数

参数

是否必选

参数类型

描述

stack_set_name

是

String

资源栈集的名称。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128

请求参数

表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

包含有关未经授权请求的信息。

请求示例

  • 通过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"
  }
}

响应示例

状态码： 202

请求接受，异步处理

{
  "stack_set_operation_id" : "fb5e781e-a27d-46e2-9954-242753857a9f"
}

状态码

状态码

描述

202

请求接受，异步处理

400

用户请求非法

401

用户身份认证失败

403

  1. 用户无权限调用此API

  2. 资源栈集状态非法，不允许创建并行操作

404

资源栈集不存在

429

请求数量过多

500

服务器内部错误
父主题： 资源栈集
分享：

    相关文档

    相关产品