资源编排服务 RFS-获取资源栈集操作的元数据:响应参数

时间:2024-04-22 15:17:29

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

stack_set_operation_id

String

资源栈集操作(stack_set_operation)的唯一Id。

此ID由资源编排服务在生成资源栈集操作的时候生成,为UUID。

最小长度:36

最大长度:36

stack_set_id

String

资源栈集(stack_set)的唯一ID。

此ID由资源编排服务在生成资源栈集的时候生成,为UUID。

由于资源栈集名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的资源栈集,删除,在重新创建一个同名资源栈集。

对于团队并行开发,用户可能希望确保,当前我操作的资源栈集就是我以为的那个,而不是又其他队友删除后创建的同名资源栈集。因此,使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈集所对应的ID都不相同,更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致,则返回400

最小长度:36

最大长度:36

stack_set_name

String

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

最小长度:1

最大长度:128

status

String

资源栈集操作状态

  • QUEUE_IN_PROGRESS - 正在排队

  • OPERATION_IN_PROGRESS - 正在操作

  • OPERATION_COMPLETE - 操作完成

  • OPERATION_FAILED - 操作失败

  • STOP_IN_PROGRESS - 正在停止

  • STOP_COMPLETE - 停止完成

  • STOP_FAILED - 停止失败

枚举值:

  • QUEUE_IN_PROGRESS

  • OPERATION_IN_PROGRESS

  • OPERATION_COMPLETE

  • OPERATION_FAILED

  • STOP_IN_PROGRESS

  • STOP_COMPLETE

  • STOP_FAILED

status_message

String

资源栈集操作失败时会展示此次操作失败的原因,例如,资源栈实例部署或删除失败个数超过上限或资源栈集操作超时。

如果需要查看详细失败信息,可通过ListStackInstances API获取查看资源栈实例的status_message。

action

String

用户当前的操作

  • CREATE_STACK_INSTANCES - 创建资源栈实例

  • DELETE_STACK_INSTANCES - 删除资源栈实例

  • DEPLOY_STACK_SET - 部署资源栈集

  • DEPLOY_STACK_INSTANCES - 部署资源栈实例

  • UPDATE_STACK_INSTANCES - 更新资源栈实例

枚举值:

  • CREATE_STACK_INSTANCES

  • DELETE_STACK_INSTANCES

  • DEPLOY_STACK_SET

  • DEPLOY_STACK_INSTANCES

  • UPDATE_STACK_INSTANCES

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

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_agency_name

String

被管理的委托名称。

资源编排服务会使用该委托获取实际部署资源所需要的权限

不同成员账号委托给管理账号的委托名称需要保持一致。暂不支持根据不同provider定义不同委托权限

当用户定义SELF_MANAGED权限类型时,必须指定该参数。当用户使用SERVICE_MANAGED权限类型时,指定该参数将报错400

创建委托及授权方式

最小长度:0

最大长度:64

deployment_targets

deployment_targets object

部署目标信息。

create_time

String

资源栈集操作的创建时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。

update_time

String

资源栈集操作的更新时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。

operation_preferences

operation_preferences object

资源栈集操作(stack_set_operation)的部署策略。该参数只在指定的单次操作中生效。

当用户不指定该参数时,默认的操作部署策略为区域(region)内资源栈实例串行部署,即每次只执行一个资源栈实例,区域(region)间随机且串行部署,执行完一个region下的全部资源栈实例后,才会选择另一个region部署,容错次数默认为0。

该参数可以在生成资源栈集操作的四个API中指定:

创建资源栈实例(CreateStackInstance),部署资源栈集(DeployStackSet),更新资源栈实例(UpdateStackInstance),删除资源栈实例(DeleteStackInstance)

表5 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

表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

状态码: 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

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

support.huaweicloud.com/api-aos/ShowStackSetOperationMetadata.html