华为云用户手册

请求示例 列举资源栈输出 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/outputs 列举资源栈输出，并提供资源栈id以校验是否与当前资源栈匹配 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/outputs?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2

响应示例 状态码： 200 获取资源栈集操作元数据成功 { "stack_set_operation_id" : "daa46d87-045b-4a50-a0d5-c167fc34b632", "stack_set_id" : "10f29827-939f-4a11-8bcc-65b051257860", "stack_set_name" : "my_hello_world_stack_set", "status" : "OPERATION_COMPLETE", "administration_agency_name" : "test_administration_agency_name", "managed_agency_name" : "test_managed_agency_name", "action" : "CREATE_STACK_INSTAN CES ", "deployment_targets" : { "domain_ids" : [ "dfda721e8ecd46088662f2dc9e97b1c6", "dfda721e8ecd46088662f2dc9e97b1c7" ], "regions" : "cn-north-5" }, "operation_preferences" : { "failure_tolerance_count" : 4, "max_concurrent_count" : 3, "region_order" : [ "cn-north-5" ], "region_concurrency_type" : "SEQUENTIAL", "failure_tolerance_mode" : "STRICT_FAILURE_TOLERANCE" }, "create_time" : "2023-05-15T15:39:25.210Z", "update_time" : "2023-05-15T16:39:25.210Z" }

响应参数 状态码： 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 包含有关未经授权请求的信息。

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

响应示例 状态码： 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 表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 - 基于部署需求，用户需要提前手动创建委托，既包含管理账号给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 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 用于定义管理资源栈集操作的一系列属性。 表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 包含有关未经授权请求的信息。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message 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

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

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

响应参数 状态码： 307 表4 响应Header参数 参数 参数类型 描述 Location String HTTP重定向指定头域，客户端可通过此头域重定向至新地址。其内容为模板下载链接，为OBS Pre Signed地址，有效期为10分钟 状态码： 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 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 429 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /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

功能介绍 获取模板版本内容（ShowTemplateVersionContent） 此API用于获取用户的模板版本内容 template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成，为UUID。由于模板名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的模板，删除，再重新创建一个同名模板。对于团队并行开发，用户可能希望确保，当前我操作的模板就是我认为的那个，而不是其他队友删除后创建的同名模板。因此，使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同，更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致，则返回400 此api会以临时重定向形式返回模板内容的下载链接，用户通过下载获取模板版本内容（OBS Pre Signed地址，有效期为5分钟） ShowTemplateVersionContent返回的信息只包含模板版本内容，如果想知道模板版本的元数据，请调用ShowTemplateVersionMetadata

请求示例 删除资源栈，不保留资源 POST https://{endpoint}/v1/{project_id}/stacks/{stack_name}/deletion { "stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3" } 删除资源栈，保留资源 POST https://{endpoint}/v1/{project_id}/stacks/{stack_name}/deletion { "stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "retain_all_resources" : true }

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表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 包含有关未经授权请求的信息。

功能介绍 条件删除资源栈（DeleteStackEnhanced） 此API用于删除某个资源栈，可以选择是否保留资源。 请谨慎操作，删除资源栈将默认删除与该资源栈相关的所有数据，如：执行计划、资源栈事件、资源栈输出、资源等。 **如果希望删除资源栈保留资源，可以在请求中设置retain_all_resources对资源进行保留。 此API会触发删除资源栈，并以最终一致性删除数据，用户可以调用GetStackMetadata或ListStacks跟踪资源栈删除情况。当删除完成后，被删除资源栈将不会在上述API中返回。 如果资源栈状态处于非终态（状态以IN_PROGRESS结尾）状态时，则不允许删除。包括但不限于以下状态： 正在部署（DEPLOYMENT_IN_PROGRESS） 正在删除（DELETION_IN_PROGRESS） 正在回滚（ROLLBACK_IN_PROGRESS） 如果资源栈开启了删除保护，则不允许删除。用户可调用GetStackMetadata，查看返回中的enable_deletion_protection字段判断删除保护是否开启。用户可通过调用UpdateStack关闭删除保护。 如果资源栈删除失败，可以根据StackEvents提示信息修复当前模板中的错误后，部署成功后再次删除资源栈。有以下两种方式触发部署： 调用CreateExecutionPlan创建执行计划，执行计划创建成功后调用ApplyExecutionPlan部署资源栈。 调用DeployStack部署资源栈。

URI POST /v1/{project_id}/stacks/{stack_name}/deletion 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，可以从调用API处获取，也可以从控制台获取。 项目ID获取方式 最小长度：3 最大长度：64 stack_name 是 String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 stack_id 否 String 资源栈（stack）的唯一Id。 此Id由资源编排服务在生成资源栈的时候生成，为UUID。 由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400 最小长度：36 最大长度：36 retain_all_resources 否 Boolean 删除资源栈是否保留资源的标志位，如果不传默认为false，即默认不保留资源（删除资源栈后会删除资源栈中的资源） DeleteStackEnhanced API中，如果该参数未在RequestBody中给予，则删除时不会保留资源栈中的资源*

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 stack_resources Array of StackResource objects 资源栈中所管理的资源信息列表 表5 StackResource 参数 参数类型 描述 physical_resource_id String 资源的物理id，由该资源的provider、云服务或其他服务提供方在资源部署的时候生成 注：与physical相关的参数可以在模板以外的地方，作为该资源的一种标识 physical_resource_name String 资源的物理名称，由该资源的provider、云服务或其他服务提供方在资源部署的时候定义 注：与physical相关的参数可以在模板以外的地方，作为该资源的一种标识 logical_resource_name String 资源的逻辑名称，由用户在模板中定义 注：与 logical 相关的参数仅仅在模板内部，作为该资源的一种标识 以HCL格式的模板为例，logical_resource_name 为 my_hello_world_vpc resource "huaweicloud_vpc" "my_hello_world_vpc" { name = "test_vpc" } 以json格式的模板为例，logical_resource_name 为 my_hello_world_vpc { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "name": "test_vpc" } } } } logical_resource_type String 资源的类型 注：与 logical 相关的参数仅仅在模板内部，作为该资源的一种标识 以HCL格式的模板为例，logical_resource_type 为 huaweicloud_vpc resource "huaweicloud_vpc" "my_hello_world_vpc" { name = "test_vpc" } 以json格式的模板为例，logical_resource_type 为 huaweicloud_vpc { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "name": "test_vpc" } } } } index_key String 资源的索引，如果用户在模板中使用了count或for_each则会返回index_key。如果index_key出现，则logical_resource_name + index_key可以作为该资源的一种标识 如果用户在模板中使用count，则index_key为从0开始的数字 以HCL格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc[0]和huaweicloud_vpc.my_hello_world_vpc[1]标识两个资源 resource "huaweicloud_vpc" "my_hello_world_vpc" { count = 2 name = "test_vpc" } 以json格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc[0]和huaweicloud_vpc.my_hello_world_vpc[1]标识两个资源 { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "name": "test_vpc", "count": 2 } } } } 如果用户在模板中使用for_each，则index_key为用户自定义的字符串 以HCL格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc["vpc1"]和huaweicloud_vpc.my_hello_world_vpc["vpc2"]标识两个资源 resource "huaweicloud_vpc" "my_hello_world_vpc" { for_each = { "vpc1" = "test_vpc" "vpc2" = "test_vpc" } name = each.value } 以json格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc["vpc1"]和huaweicloud_vpc.my_hello_world_vpc["vpc2"]标识两个资源 { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "for_each": { "vpc1": "test_vpc", "vpc2": "test_vpc" } "name": "${each.value}" } } } } resource_status String 资源的状态 CREATION_IN_PROGRESS - 正在生成 CREATION_FAILED - 生成失败 CREATION_COMPLETE - 生成完成 DELETION_IN_PROGRESS - 正在删除 DELETION_FAILED - 删除失败 DELETION_COMPLETE - 已经删除 UPDATE_IN_PROGRESS - 正在更新。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION UPDATE_FAILED - 更新失败。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION UPDATE_COMPLETE - 更新完成。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION 枚举值： CREATION_IN_PROGRESS CREATION_FAILED CREATION_COMPLETE DELETION_IN_PROGRESS DELETION_FAILED DELETION_COMPLETE UPDATE_IN_PROGRESS UPDATE_FAILED UPDATE_COMPLETE status_message String 当该资源状态为任意失败状态（即以 FAILED 结尾时），将会展示简要的错误信息总结以供debug resource_attributes Array of ResourceAttribute objects 资源属性列表 表6 ResourceAttribute 参数 参数类型 描述 key String 资源属性的键 value String 资源属性的值 状态码： 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 包含有关未经授权请求的信息。

响应示例 状态码： 200 列举资源栈资源成功 { "stack_resources" : [ { "logical_resource_name" : "vpc", "logical_resource_type" : "huaweicloud_vpc", "physical_resource_id" : "38d617da-9b7f-4550-9ff7-d0e271dd4735", "physical_resource_name" : "my_vpc", "resource_attributes" : [ { "key" : "cidr", "value" : "172.16.0.0/16" }, { "key" : "description", "value" : "" }, { "key" : "enterprise_project_id", "value" : "0" }, { "key" : "id", "value" : "38d617da-9b7f-4550-9ff7-d0e271dd4735" }, { "key" : "name", "value" : "test_name" }, { "key" : "region", "value" : "cn-north-7" }, { "key" : "routes", "value" : "[]" }, { "key" : "secondary_cidr", "value" : "null" }, { "key" : "status", "value" : "OK" }, { "key" : "tags", "value" : "null" }, { "key" : "timeouts", "value" : "null" } ], "resource_status" : "CREATION_COMPLETE" } ] }

请求示例 列举资源栈资源 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/resources 列举资源栈资源，并提供资源栈id以校验是否与当前资源栈匹配 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/resources?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2

功能介绍 列举资源栈资源（ListStackResources） 此API用于列举资源栈中当前管理的所有资源的信息 当资源栈处于非终态时，仅输出资源栈下资源的简要信息，包含逻辑资源名称（logical_resource_name），逻辑资源类型（logical_resource_type），物理资源id（physical_resource_id），物理资源名称（physical_resource_name），资源状态（status）等信息；当资源栈处于终态时，将额外输出具体信息，如资源属性（resource_attributes） 非终态包括但不限于以下状态： 正在部署（DEPLOYMENT_IN_PROGRESS） 正在删除（DELETION_IN_PROGRESS） 正在回滚（ROLLBACK_IN_PROGRESS）

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

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 deployment_id String 标识部署的唯一Id，此Id由资源编排服务在触发部署、回滚等操作时生成，为UUID。 接受请求，进行异步处理。可以调用GetStackMetadata来获取异步请求的部署状态 注意： 部署资源栈后，资源编排服务持久化请求并立即返回，客户端不等待请求最终处理完成，用户无法实时感知请求处理结果 资源编排服务最终会将异步部署请求排队，在服务端空闲的情况下逐个处理。用户最大等待时长为6小时 状态码： 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 包含有关未经授权请求的信息。 状态码： 409 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表11 响应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参数 参数 是否必选 参数类型 描述 execution_plan_id 否 String 执行计划（execution_plan）的唯一Id。 此Id由资源编排服务在生成执行计划的时候生成，为UUID。 由于执行计划名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的执行计划，删除，再重新创建一个同名执行计划。 对于团队并行开发，用户可能希望确保，当前我操作的执行计划就是我认为的那个，而不是其他队友删除后创建的同名执行计划。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的执行计划所对应的ID都不相同，更新不会影响ID。如果给予的execution_plan_id和当前执行计划的ID不一致，则返回400 注意： 创建执行计划后，资源编排服务持久化请求并立即返回，客户端不等待请求最终处理完成，用户无法实时感知请求处理结果 资源编排服务最终会将异步部署请求排队，在服务端空闲的情况下逐个处理。用户最大等待时长为1小时 最小长度：36 最大长度：36 stack_id 否 String 资源栈（stack）的唯一Id。 此Id由资源编排服务在生成资源栈的时候生成，为UUID。 由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400 最小长度：36 最大长度：36

请求示例 执行指定资源栈下的执行计划 POST https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan 执行指定资源栈下的执行计划，并提供资源栈id以校验是否与当前资源栈匹配 POST https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan { "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7" }

URI POST /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，可以从调用API处获取，也可以从控制台获取。 项目ID获取方式 最小长度：3 最大长度：64 stack_name 是 String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128 execution_plan_name 是 String 执行计划的名称。此名字在domain_id+区域+project_id+stack_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128

功能介绍 执行执行计划（ApplyExecutionPlan） 此API用于执行一个执行计划 当执行请求接受后，执行计划状态将变为APPLY_IN_PROGRESS，后台会进行异步处理。 当执行结束后，执行计划状态将变为APPLIED。 用户可以调用GetStackMetadata查询资源栈的状态（status）来跟踪资源栈部署情况以及确认本次执行结果是否成功。 如果不希望通过执行计划进行部署操作，也可以选择调用DeployStack进行直接部署 关于执行计划的过期失效： 如果指定资源栈下有多个执行计划，则在执行某个执行计划后（无论结果是否成功），剩余所有的执行计划将过期失效； 如果调用ApplyExecutionPlan时，指定的执行计划已经过期失效，则返回403 如果资源栈状态处于非终态（即以IN_PROGRESS结尾，详细见下方）状态时，则不允许执行执行计划，并返回403。非终态状态包括但不限于以下状态： 正在部署（DEPLOYMENT_IN_PROGRESS） 正在删除（DELETION_IN_PROGRESS） 正在回滚（ROLLBACK_IN_PROGRESS）

响应示例 状态码： 200 获取资源栈实例成功 { "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7", "stack_set_name" : "my_hello_world_stack_set", "latest_stack_set_operation_id" : "3fef5d3e-27b6-44e8-9769-1d7262bd9430", "status" : "OPERATION_COMPLETE", "stack_id" : "ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2", "stack_name" : "my_hello_world_stack", "stack_domain_id" : "6cbcca2a2f114a63841bdbc7a19b7b09", "region" : "cn-north-7", "create_time" : "2023-05-15T15:39:25.210Z", "update_time" : "2023-05-15T16:39:25.210Z", "var_overrides" : { "vars_body" : "var_key1=\"var_value1\"", "vars_uri_content" : "var_key2=\"var_value2\"" } }

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

响应参数 状态码： 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 status String 资源栈实例的状态 WAIT_IN_PROGRESS - 资源栈实例等待操作中 CANCEL_COMPLETE - 资源栈实例操作取消完成 OPERATION_IN_PROGRESS - 资源栈实例操作中 OPERATION_FAILED - 资源栈实例操作失败 INOPERABLE - 资源栈实例不可操作 OPERATION_COMPLETE - 资源栈实例操作完成 枚举值： WAIT_IN_PROGRESS CANCEL_COMPLETE OPERATION_IN_PROGRESS OPERATION_FAILED INOPERABLE OPERATION_COMPLETE status_message String 在资源栈实例状态为INOPERABLE或OPERATION_FAILED时，会显示简要的错误信息总结以供debug stack_id String 资源栈（stack）的唯一ID。 此ID由资源编排服务在生成资源栈的时候生成，为UUID。 由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400 stack_name String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 最小长度：1 最大长度：128 stack_domain_id String 资源栈实例所关联的资源栈所在的租户ID latest_stack_set_operation_id String 最新一次部署该资源栈实例的资源栈集操作ID 此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID region String 资源栈实例所关联的资源栈所在的区域 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 var_overrides var_overrides object 该资源栈实例的参数覆盖内容 如果用户通过CreateStackInstances或UpdateStackInstances API 对该资源栈实例设置了参数覆盖，该字段会返回资源栈实例记录的最新参数覆盖内容 如果该字段未返回，用户使用资源栈集中记录的参数部署该实例 表5 var_overrides 参数 参数类型 描述 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 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 429 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度：11 最大长度：11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。