文档首页> 资源编排服务 RFS> API参考> 资源编排API> 资源栈集> 获取资源栈集元数据
更新时间：2024-06-28 GMT+08:00
查看PDF

获取资源栈集元数据

功能介绍

获取资源栈集元数据（ShowStackSetMetadata）

  • 用户可以使用此API获取资源栈集的元数据

URI

GET /v1/stack-sets/{stack_set_name}/metadata

表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

call_identity

否

String

仅支持资源栈集权限模式为SERVICE_MANAGED时指定该参数。用于指定用户是以组织管理账号还是成员帐户中的服务委托管理员身份调用资源栈集。默认为SELF。

  • 无论指定何种用户身份，创建或部署的资源栈集始终在组织管理账号名下。*

    • SELF - 以组织管理账号身份调用。

    • DELEGATED_ADMIN - 以服务委托管理员身份调用。用户的华为云账号必须在组织中已经被注册为”资源编排资源栈集服务“的委托管理员。

枚举值：

  • SELF

  • DELEGATED_ADMIN

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

最小长度：36

最大长度：128

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

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

stack_set_description

String

资源栈集的描述。可用于客户识别自己的资源栈集。

最小长度：0

最大长度：1024

initial_stack_description

String

初始化资源栈描述。可用于客户识别被资源栈集所管理的资源栈。

资源栈集下的资源栈仅在创建时统一使用该描述。客户想要更新初始化资源栈描述，可以通过UpdateStackSet API。

后续更新资源栈集描述将不会同步更新已管理的资源栈描述。

最小长度：0

最大长度：1024

permission_model

String

权限模型，定义了RFS操作资源栈集时所需委托的创建方式，枚举值，默认为SELF_MANAGED。用户可以使用创建资源栈集（CreateStackSet）API 指定该参数。该参数暂不支持更新。用户如果想要更新权限模型，可以通过先删除再创建同名资源栈集实现。

  • SELF_MANAGED - 自我管理，基于部署需求，用户需要提前手动创建委托，既包含管理账号授权给RFS的委托，也包含成员账号授权给管理账号的委托。如果委托不存在或权限不足，创建资源栈集不会失败，创建资源栈实例时才会报错。

  • SERVICE_MANAGED - 服务管理，基于Organization服务，RFS会自动创建部署Organization 成员账号时所需的全部 IAM 委托。用户需要提前在Organization可信服务列表中将”资源编排资源栈集服务“启用，且只有Organization的管理账号或”资源编排资源栈集服务“的委托管理员，才允许指定SERVICE_MANAGED创建资源栈集，否则会报错。

缺省值：SELF_MANAGED

枚举值：

  • SELF_MANAGED

  • SERVICE_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

status

String

资源栈集的状态

  • IDLE - 资源栈集空闲

  • OPERATION_IN_PROGRESS - 资源栈集操作中

  • DEACTIVATED - 资源栈集禁用

枚举值：

  • IDLE

  • OPERATION_IN_PROGRESS

  • DEACTIVATED

vars_uri_content

String

vars_uri对应的文件内容

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

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。

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

用于定义管理资源栈集操作的一系列属性。

organizational_unit_ids

Array of strings

组织单元（Organizational Unit，缩写OU）ID列表，仅在资源栈集权限模型是SERVICE_MANAGED时，才允许指定该参数。

用户指定的Organization组织部署的ID列表，可以是根组织（Root）ID，也可以是某些组织单元的ID。

创建资源栈实例 （CreateStackInstances）API 必须指定该参数，该API 会异步校验OU IDs 的合法性，校验有效的OU IDs 及其所有非空子OU ID 都会被资源栈集记录管理。该API允许指定没有或者已经被资源栈集管理的OU IDs。

  • 若资源栈集不自动部署，空子OU不会被资源栈集记录管理（特指子OU下无成员账号或部署排除其下所有成员账号）。*

  • 【暂不支持】若资源栈集开启自动部署，空子OU也会被资源栈集记录管理（特指子OU下无成员账号或部署排除其下所有成员账号），自动部署仅针对成员账号变动，不针对其他组织结构变化，例如新增OU等，新增OU不会自动被资源栈集管理。*

部署或删除资源栈实例（DeployStackSet、UpdateStackInstances、DeleteStackInstances） API，只允许指定已经被资源栈集管理的OU IDs。若指定了没有被资源栈集记录管理的OU IDs，则会报错。

删除资源栈实例 （DeleteStackInstances）API 必须指定该参数。

用户可以通过获取资源栈集元数据（ShowStackSetMetadata）API ，获取通过创建资源栈实例（CreateStackInstances）API 请求指定过的OU IDs。

资源栈集不仅会部署到目标 OU 中的用户，同时还会部署所有子 OU 下的用户。指定该参数后，资源栈集会根据用户输入的 OU 列表下所有的用户信息（包含子 OU 下的用户）和region列表，以笛卡尔积的形式，选择资源栈实例进行创建或部署。

资源栈集不会选择组织管理员作为部署目标，进行资源栈实例的创建或部署，即使组织管理员位于给与的组织或组织的 OU 中。

数组长度：1 - 100
表5 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个处于运行态的资源栈集操作*

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表7 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表9 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表11 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表13 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 429

表14 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表15 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 500

表16 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表17 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

请求示例

  • 获取指定资源栈集的元数据

    GET https://{endpoint}/v1/stack_sets/my_hello_world_stack_set/metadata

  • 获取资源栈集元数据，并提供资源栈集id以校验是否与当前资源栈集匹配

    GET https://{endpoint}/v1/stack_sets/my_hello_world_stack_set/metadata?stack_set_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2

响应示例

状态码： 200

获取资源栈集元数据成功

{
  "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
  "stack_set_name" : "my_hello_world_stack_set",
  "stack_set_description" : "my first stack set",
  "initial_stack_description" : "my stack created by stack set",
  "permission_model" : "SELF_MANAGED",
  "managed_agency_name" : "my_managed_agency_name",
  "administration_agency_name" : "my_administration_agency_name",
  "status" : "OPERATION_IN_PROGRESS",
  "create_time" : "2023-03-16T03:28:20.210Z",
  "update_time" : "2023-05-24T08:56:10.210Z",
  "managed_operation" : {
    "enable_parallel_operation" : false
  }
}

状态码

状态码

描述

200

获取资源栈集元数据成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈集不存在

429

请求数量过多

500

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