华为云用户手册

请求示例 获取当前局点下用户所有的私有模块，以创建时间降序排序 GET https://{endpoint}/v1/private-modules 获取当前局点下用户所有的私有模块，以创建时间降序排序 GET https://{endpoint}/v1/private-modules?sort_key=create_time&sort_dir=desc 获取当前局点下用户所有的私有模块，以创建时间升序排序 GET https://{endpoint}/v1/private-modules?sort_key=create_time&sort_dir=asc

功能介绍 列举私有模块（ListPrivateModules） 列举当前局点下用户所有的私有模块。 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。 如果当前用户下没有任何私有模块，则返回空list。 如果需要某个模块的所有版本信息，可以调用ListModuleVersions。 ListPrivateModules返回的只有摘要信息（具体摘要信息见ListPrivateModulesResponseBody），如果用户需要详细的模块元数据请调用ShowPrivateModuleMetadata

响应示例 状态码：200 询价成功 { "currency" : "CNY", "items" : [ { "resource_type" : "huaweicloud_vpc", "resource_name" : "vpc", "resource_price" : [ { "charge_mode" : "FREE", "discount" : 0, "original_price" : 0, "sale_price" : 0 } ], "supported" : true } ] }

请求示例 预估执行计划价格，该执行计划中包含了一个新创建的vpc资源 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan/prices 预估执行计划价格，该执行计划中包含了一个新创建的vpc资源，并提供资源栈id和执行计划id以校验是否与当前资源栈和执行计划匹配 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan/prices?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2&execution_plan_id=fb5e781e-a27d-46e2-9954-242753857a9f

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 currency String 币种，枚举值 CNY - 元，中国站返回的币种 items Array of ItemsResponse objects 执行计划中所有资源的询价结果 表5 ItemsResponse 参数 参数类型 描述 resource_type String 资源的类型 以HCL格式的模板为例，resource_type 为 huaweicloud_vpc resource "huaweicloud_vpc" "my_hello_world_vpc" { name = "test_vpc" } 以json格式的模板为例，resource_type 为 huaweicloud_vpc { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "name": "test_vpc" } } } } resource_name String 资源的名称，默认为资源的逻辑名称 以HCL格式的模板为例，resource_name 为 my_hello_world_vpc resource "huaweicloud_vpc" "my_hello_world_vpc" { name = "test_vpc" } 以json格式的模板为例，resource_name 为 my_hello_world_vpc { "resource": { "huaweicloud_vpc": { "my_hello_world_vpc": { "name": "test_vpc" } } } } index String 资源的索引，如果用户在模板中使用了count或for_each则会返回index。如果index出现，则resource_name + index可以作为该资源的一种标识 如果用户在模板中使用count，则index为从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为用户自定义的字符串 以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}" } } } } module_address String 该资源的模块地址 supported Boolean 该资源或该资源当前所给予的参数是否支持进行询价 unsupported_message String 该资源不支持询价的具体原因 resource_price Array of ResourcePriceResponse objects 该资源的询价信息 如果该资源支持包周期计费或按需计费，或者该资源为免费资源，则返回该字段；如果该资源不支持询价，则不返回该字段。 表6 ResourcePriceResponse 参数 参数类型 描述 charge_mode String 计费模式 PRE_PAID - 包周期计费 POST_PAID - 按需计费 FREE - 免费 sale_price Double 该资源最终优惠后的金额（只考虑官网折扣、商务折扣以及伙伴折扣，不包含促销折扣及优惠券），保留小数点后2位，向上取整，默认单位是元。 discount Double 该资源的总优惠额，保留小数点后2位，向上取整，默认单位是元。 original_price Double 该资源的原价，保留小数点后2位，向上取整，默认单位是元。 period_type String 计费单位 如果该资源支持包周期计费或按需计费，则会返回该字段；如果该资源为免费资源，则不返回该字段。 HOUR - 小时，按需计费的单位 DAY - 天，按需计费的单位 MONTH - 月，包周期计费的单位 YEAR - 年，包周期计费的单位 BYTE - 字节，按需计费的单位 MB - 百万字节，包周期计费和按需计费的单位 GB - 千兆字节，包周期计费和按需计费的单位 period_count Integer 该资源的计费数量，需要和period_type搭配使用 如果该资源支持包周期计费或按需计费，则会返回该字段；如果该资源为免费资源，则不返回该字段。 对于按需计费资源，此值默认返回1，代表在1个计费单位下，该资源的价格 对于包周期计费资源，此值与模板中该资源的period字段保持一致 best_discount_type Integer 该资源的最优折扣类型 对于按需计费资源的折扣类型 合同商务优惠类型：605 （华为云商务-折扣率，一口价，华为云用户）、606 （渠道商务-折扣率，一口价，BP用户） 伙伴折扣优惠类型：607 (合作伙伴授予折扣-折扣率) 对于包周期计费资源的折扣类型 合同商务折扣：605（华为云BE场景下的合同商务折扣）、606（分销商BE场景下的合同商务折扣） 伙伴授予折扣：607 促销折扣：700 如果该资源存在折扣，则返回该字段；如果该资源不存在折扣，则不返回该字段。 best_discount_price Double 最优折扣优惠额，保留小数点后2位，向上取整，默认单位是元。 如果该资源存在折扣，则返回该字段；如果该资源不存在折扣，则不返回该字段。 official_website_discount_price Double 官网价优惠额，保留小数点后2位，向上取整，默认单位是元。 如果该资源存在官网价优惠额，则返回该字段；如果该资源不存在官网价优惠额，则不返回该字段。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表17 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表18 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

功能介绍 预估执行计划价格（EstimateExecutionPlanPrice） 此API可以基于一份已有的执行计划中增量的资源进行询价，当前支持询价的计费模式有包周期计费、按需计费、免费，暂不支持其他形式的计费模式，例如竞价计费模式等。 注： 由于某些资源的属性值含有默认值，且该属性和询价参数相关。如果用户的模板中描述的资源没有声明这些属性，则询价结果可能存在偏差。 询价结果仅为预估结果，具体请以实际为准。 如果用户在模板中使用了depends_on参数，如A资源询价必要字段依赖于B资源的创建，则A资源不支持询价。 暂不支持传入data sources的flavor.id的场景的询价。 暂不支持镜像询价。 如果A资源的询价必要字段设置了sensitive = true，则A资源不支持询价。 模板中询价的资源的个数是有限制的。当前一个模板中最多支持12个包周期计费资源和24个按需计费资源。 支持询价的资源列表和询价必要参数 huaweicloud_cce_cluster: 支持的计费模式：包周期、按需 huaweicloud_css_cluster: 支持的计费模式：按需 huaweicloud_evs_volume: 支持的计费模式：包周期、按需 询价必要参数：size（磁盘规格） huaweicloud_compute_instance: 支持的计费模式：包周期、按需 询价必要参数：flavor_id（规格ID）、flavor_name（规格名称，flavor_id和flavor_name至少给出一个）、system_disk_size（系统磁盘大小） huaweicloud_vpc_bandwidth: 支持的计费模式：按需 询价必要参数：charge_mode仅支持bandwidth huaweicloud_vpc_eip: 支持的计费模式：包周期、按需 询价必要参数：bandwidth.size（带宽大小） huaweicloud_gaussdb_redis_instance: 支持的计费模式：包周期、按需 huaweicloud_nat_gateway: 支持的计费模式：按需 huaweicloud_rds_instance: 支持的计费模式：包周期、按需 支持的数据库类型：MySQL、PostgreSQL、Microsoft SQL Server huaweicloud_sfs_turbo: 支持的计费模式：按需 询价必要参数：share_type（文件系统类型） huaweicloud_dms_kafka_instance: 支持的计费模式：按需 询价必要参数：flavor_id（规格ID）、product_id（产品ID。flavor_id和product_id至少给出一个。）、storage_space（存储容量） huaweicloud_dcs_instance: 支持的计费模式：包周期、按需 huaweicloud_gaussdb_mysql_instance: 支持的计费模式：包周期、按需 询价必要参数：proxy_node_number（代理节点数量）、volume_size（挂载卷的存储空间） huaweicloud_vpc: 支持的计费模式：免费 huaweicloud_drs_job: 支持的计费模式：按需 huaweicloud_apig_instance: 支持的计费模式：按需 huaweicloud_dms_rabbitmq_instance: 支持的计费模式：包周期、按需 huaweicloud_hss_quota: 支持的计费模式：包周期 huaweicloud_hss_host_protection: 支持的计费模式：按需 huaweicloud_cbr_vault: 支持的计费模式：包周期、按需 huaweicloud_cbh_instance: 支持的计费模式：包周期 huaweicloud_cbh_ha_instance: 支持的计费模式：包周期 huaweicloud_waf_cloud_instance: 支持的计费模式：包周期 huaweicloud_lb_loadbalancer: 支持的计费模式：包周期、按需 huaweicloud_elb_loadbalancer: 支持的计费模式：按需 huaweicloud_modelarts_resource_pool: 支持的计费模式：包周期、按需 huaweicloud_cnad_advanced_black_white_list: 支持的计费模式：免费 huaweicloud_cnad_advanced_policy: 支持的计费模式：免费 huaweicloud_cnad_advanced_protected_object: 支持的计费模式：免费 huaweicloud_antiddos_basic: 支持的计费模式：免费 huaweicloud_obs_bucket: 支持的计费模式：免费 huaweicloud_obs_bucket_replication: 支持的计费模式：免费 huaweicloud_workspace_desktop: 支持的计费模式：按需 huaweicloud_dws_cluster: 支持的计费模式：按需 huaweicloud_dws_ext_data_source: 支持的计费模式：免费 huaweicloud_dws_snapshot: 支持的计费模式：免费 huaweicloud_dds_instance: 支持的计费模式：包周期、按需 huaweicloud_rds_read_replica_instance: 支持的计费模式：包周期、按需 huaweicloud_cce_node: 支持的计费模式：包周期、按需 huaweicloud_dms_rocketmq_instance: 支持的计费模式：包周期、按需 huaweicloud_gaussdb_opengauss_instance: 支持的计费模式：包周期、按需 huaweicloud_vpcep_endpoint: 支持的计费模式：按需 huaweicloud_kms_key: 支持的计费模式：按需

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 表3 请求Body参数 参数 是否必选 参数类型 描述 template_body 否 String HCL模板，描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 在CreateStack API中，template_body和template_uri可以都不给予 注意： template_body中默认不应该含有任何敏感信息，资源编排服务会直接明文使用、log、展示、存储对应的template_body。如为敏感信息，建议将敏感信息通过vars_structure参数化，并设置encryption字段开启加密 template_uri 否 String HCL模板的OBS地址，该模板描述了资源的目标状态。资源编排服务将比较此模板与当前远程资源的状态之间的区别。 请确保OBS地址所在局点与使用 RFS 服务局点一致。 对应的文件应该是纯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

请求示例 通过策略文件的uri在指定的私有hook下创建私有hook版本 POST https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions { "hook_version" : "0.0.1", "policy_uri" : "https://my_hello_world_bucket.{region}.myhuaweicloud.com/policy.rego", "hook_version_description" : "my first private hook version" } 通过策略内容在指定的私有hook下创建私有hook版本 POST https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions { "hook_version" : "0.0.2", "policy_body" : "package policy\n\nimport rego.v1\n\nhook_result := {\n\"is_passed\": input.message == \"world\",\n\"err_msg\": \"The error msg when private hook is not passed the validation\",\n}", "hook_version_description" : "my second private hook version" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID 表3 请求Body参数 参数 是否必选 参数类型 描述 hook_id 否 String 私有hook（private-hook）的唯一Id。 此Id由资源编排服务在生成私有hook的时候生成，为UUID。 由于私有hook名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有hook，删除，再重新创建一个同名私有hook。 对于团队并行开发，用户可能希望确保，当前我操作的私有hook就是我认为的那个，而不是其他队友删除后创建的同名私有hook。因此，使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有hook所对应的Id都不相同，更新不会影响Id。如果给予的hook_id和当前hook的Id不一致，则返回400。 hook_version 是 String 私有hook的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。 hook_version_description 否 String 私有hook版本的描述。可用于客户识别创建私有hook的版本。注意：hook版本为不可更新（immutable），所以该字段不可更新，如果需要更新，请删除后重建。 policy_uri 否 String 策略文件的OBS地址。内容仅支持OPA开源引擎识别的，以Rego（https://www.openpolicyagent.org/docs/latest/policy-language/）语言编写的策略模板。 请确保OBS地址所在局点与使用RFS服务局点一致。 策略文件当前支持单文件或zip压缩包，单文件需要以".rego"结尾，压缩包当前只支持zip格式，文件需要以 .zip结尾。 关于策略文件的校验要求如下： 文件必须是UTF8编码 创建时会对大小、格式、语法等进行校验 策略文件必须是UTF-8编码 单文件或压缩包解压前后的大小应控制在1MB以内 压缩包内的文件数量不能超过100个 压缩包内的文件路径最长为2048 压缩包内的文件名最长为255个字节 policy_uri和policy_body必须有且只有一个存在 policy_body 否 String 策略内容。仅支持OPA开源引擎识别的，以Rego（https://www.openpolicyagent.org/docs/latest/policy-language/）语言编写的策略模板。 policy_body和policy_uri 必须有且只有一个存在

响应参数 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表5 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：409 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 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 响应码 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 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表17 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

URI POST /v1/private-hooks/{hook_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 hook_name 是 String 私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。

功能介绍 创建私有hook版本（CreatePrivateHookVersion） 创建私有hook版本，创建私有hook版本后需要调用UpdatePrivateHook API设置为默认版本才能生效。 版本号遵循语义化版本号（Semantic Version），为用户自定义。 若hook_name和hook_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。 资源编排服务会对私有hook进行校验，如文件大小，策略文件语法校验等。若存在错误，则会创建失败。

响应示例 状态码：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。 stack_set_id String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，再重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是被其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 stack_set_name String 资源栈集（stack_set）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 status String 资源栈集操作状态 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 - 更新资源栈实例 administration_agency_name String 管理委托名称 资源编排服务使用该委托获取成员账号委托给管理账号的权限。该委托中必须含有iam:tokens:assume权限，用以后续获取被管理委托凭证。如果不包含，则会在新增或者部署实例时报错。 当用户定义SELF_MANAGED权限类型时，administration_agency_name和administration_agency_urn 必须有且只有一个存在。 推荐用户在使用信任委托时给予administration_agency_urn，administration_agency_name只支持接收委托名称，如果给予了信任委托名称，则会在部署模板时失败。 当用户使用SERVICE_MANAGED权限类型时，指定该参数将报错400。 创建委托及授权方式 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 创建委托及授权方式 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，则会报错。 当资源栈集权限模型是SERVICE_MANAGED时，该参数需结合domain_id_filter_type使用。用于指定资源栈集操作涉及到的，从所提供的OU中指定或排除部署的租户ID信息，或除提供的OU外，还进行额外部署的租户ID信息。 domain_ids和domain_ids_uri 有且仅有一个存在。 domain_ids_uri String 当资源栈集权限模型是SELF_MANAGED时，用户指定包含本次操作涉及到的租户ID内容文件的OBS地址。 内容格式要求每个租户ID以逗号（,）分隔，支持换行。当前仅支持csv文件，且文件的编码格式须为UTF-8。文件内容大小不超过100KB。 上传的csv文件应尽量避免Excel操作，以防出现读取内容不一致的问题。推荐使用记事本打开确认内容是否符合预期。 在DeployStackSet API中，如果指定该参数，根据用户输入的domain_ids_uri文件内容和regions列表，以笛卡尔积的形式选择资源栈集中存在的资源栈实例进行部署。如果内容包含了没有被资源栈集所管理的domain_id，则会报错。 当资源栈集权限模型是SERVICE_MANAGED时，该参数需结合domain_id_filter_type使用。链接文件内容用于指定资源栈集操作涉及到的，从所提供的OU中指定或排除部署的租户ID信息，或除提供的OU外，还进行额外部署的租户ID信息。 domain_ids和domain_ids_uri有且仅有一个存在。 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 中。 domain_id_filter_type String 租户ID筛选类型，仅支持资源栈集权限模型是SERVICE_MANAGED时指定该参数。默认为NONE 用户可以指定不同的筛选类型，通过domain_ids或domain_ids_uri 指定或排除部署的用户信息，以增加或限制部署目标用户范围，实现不同的部署策略。 INTERSECTION - 从所提供的 OUs 中选择指定用户进行部署。指定该类型时，domain_ids和domain_ids_uri 有且仅能有一个存在。 DIFFERENCE - 从所提供的 OUs 中排除指定用户部署。指定该类型时，domain_ids和domain_ids_uri 有且仅能有一个存在。 UNION - 除了部署到提供的 OUs 外，还将部署到指定的账号中。用户可以通过同时指定organizational_unit_ids 和 domain_ids/domain_ids_uri 以实现在同一请求中部署整个OU和来自不同OU的特定个人账号。指定该类型时，domain_ids和domain_ids_uri 有且仅能有一个存在。创建资源栈实例（CreateStackInstances）除外，该API 不允许指定使用该类型。 NONE - 只部署在指定 OUs 中的所有账号。该类型下domain_ids和domain_ids_uri字段必须为空。 表6 operation_preferences 参数 参数类型 描述 region_concurrency_type String 部署资源栈实例时区域（region）的执行策略，分为两种，SEQUENTIAL和PARALLEL，区分大小写，默认值为SEQUENTIAL 详细介绍： SEQUENTIAL：顺序执行，执行完一个region下的全部资源栈实例后再去执行另一个region。默认顺序执行。 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 仅能有一个存在。 failure_tolerance_percentage Long 容错百分比。定义每个区域（region）下，允许部署失败的资源栈实例数占该region下所有资源栈实例数的百分比。该参数取值默认为0，限定0和正整数。 通过容错百分比*资源栈实例数，并向下取整，得到实际容错次数。 failure_tolerance_count 和 failure_tolerance_percentage 仅能有一个存在。 max_concurrent_count Long 每个区域（region）下可同时部署资源栈实例的最大账号数。该参数取值默认为1，限定为正整数。 最大并发账号数最多比容错次数多1。如果用户指定failure_tolerance_percentage，最大并发账号数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 max_concurrent_percentage Long 最大并发账号百分比，每个区域（region）中可同时部署的资源栈实例的最大账号百分比。该参数取值默认为1，限定正整数。 RFS根据百分比 *（每个region下资源栈实例数）得到的值，再向下取整，得到实际最大并发账号数。如果实际最大并发账号数向下取整值为0时，则默认选择最大并发账号数为1。 通过百分比计算得到的实际最大并发账号数最多比容错次数多1。如果用户指定failure_tolerance_percentage，实际最大并发账号数最多比 failure_tolerance_percentage * 资源栈实例数多1。保证部署在所需的容错级别停止。 max_concurrent_count 和 max_concurrent_percentage 仅能有一个存在。 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 (failure_tolerance_percentage) 与实际并发数分离开。该参数允许资源栈集操作始终以指定的 max_concurrent_count 或 max_concurrent_percentage 操作资源栈实例。 此时不保证资源栈实例失败总数小于 failure_tolerance_count + 1，如果用户指定的是failure_tolerance_percentage的值，则不保证资源栈实例失败总数小于 failure_tolerance_percentage * 资源栈实例数 + 1。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表17 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表18 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

URI GET /v1/stack-sets/{stack_set_name}/operations/{stack_set_operation_id}/metadata 表1 路径参数 参数 是否必选 参数类型 描述 stack_set_name 是 String 资源栈集的名称。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 stack_set_operation_id 是 String 资源栈集操作（stack_set_operation）的唯一Id。 此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID。 表2 Query参数 参数 是否必选 参数类型 描述 stack_set_id 否 String 资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，再重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我认为的那个，而不是其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 call_identity 否 String 仅支持资源栈集权限模式为SERVICE_MANAGED时指定该参数。用于指定用户是以组织管理账号还是成员账号中的服务委托管理员身份调用资源栈集。默认为SELF。 无论指定何种用户身份，创建或部署的资源栈集始终在组织管理账号名下。* SELF - 以组织管理账号身份调用。 DELEGATED_ADMIN - 以服务委托管理员身份调用。用户的华为云账号必须在组织中已经被注册为”资源编排资源栈集服务“的委托管理员。

响应示例 状态码：200 列举私有hook成功 { "hooks" : [ { "hook_id" : "5009b614-184f-fdd0-2d29-a376b76184b6", "hook_name" : "test-hook-name-1", "hook_description" : "Test Hook1 Description", "default_version" : "1.2.3", "configuration" : { "target_stacks" : "NONE", "failure_mode" : "WARN" }, "create_time" : "2024-06-01T01:00:00.000Z", "update_time" : "2024-06-01T02:00:00.000Z" }, { "hook_id" : "55a69e5a-6563-5358-86a0-e4be65312680", "hook_name" : "test-hook-name-2", "hook_description" : "Test Hook2 Description", "default_version" : "1.2.3", "configuration" : { "target_stacks" : "NONE", "failure_mode" : "WARN" }, "create_time" : "2024-05-01T01:00:00.000Z", "update_time" : "2024-05-01T02:00:00.000Z" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 hooks Array of PrivateHookSummary objects 私有hook的列表。默认以创建时间降序排序。 表4 PrivateHookSummary 参数 参数类型 描述 hook_name String 私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。 hook_id String 私有hook（private-hook）的唯一Id。 此Id由资源编排服务在生成私有hook的时候生成，为UUID。 由于私有hook名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有hook，删除，再重新创建一个同名私有hook。 对于团队并行开发，用户可能希望确保，当前我操作的私有hook就是我认为的那个，而不是其他队友删除后创建的同名私有hook。因此，使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有hook所对应的Id都不相同，更新不会影响Id。如果给予的hook_id和当前hook的Id不一致，则返回400。 hook_description String 私有hook的描述。可用于客户识别创建的私有hook。可通过UpdatePrivateHook API更新私有hook的描述。 default_version String 私有hook的默认版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。 configuration configuration object 私有hook配置项，可以指定私有hook生效的目标资源栈以及私有hook校验失败后资源栈的行为。可通过UpdatePrivateHook API更新私有hook配置项。 create_time String 私有Hook（private-hook）的生成时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。 update_time String 私有Hook（private-hook）的更新时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。 表5 configuration 参数 参数类型 描述 target_stacks String 指定私有hook生效的目标资源栈，有效值为NONE或ALL。 NONE：指定此私有hook不会作用于任何资源栈 ALL：指定此私有hook将会应用于账号下的所有资源栈 failure_mode String 指定私有hook校验失败后的行为，有效值为FAIL或WARN。 FAIL：指定此私有hook校验失败后资源栈将停止部署，资源栈状态将更新为DEPLOYMENT_FAILED。 WARN：指定此私有hook校验失败后仅通过资源栈事件展示警告消息，但不影响资源栈部署。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 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 响应码 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 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

请求示例 获取当前局点下用户所有的私有hook，以创建时间降序排序 GET https://{endpoint}/v1/private-hooks 获取当前局点下用户所有的私有hook，以创建时间升序排序 GET https://{endpoint}/v1/private-hooks?sort_key=create_time&sort_dir=asc 获取当前局点下用户所有的私有hook，以创建时间降序排序 GET https://{endpoint}/v1/private-hooks?sort_key=create_time&sort_dir=desc

功能介绍 列举私有hook（ListPrivateHooks） 列举当前局点下用户所有的私有hook。 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir的数量须一致，否则返回400。若未给予sort_key和sort_dir，则默认按照创建时间降序排序。 注意：目前暂时返回全量hook的信息，即不支持分页。 若当前用户没有任何私有hook，则返回空list。 具体返回的信息见ListPrivateHooksResponseBody。

响应示例 状态码：200 获取私有模块元数据成功 { "module_name" : "test-limit_vpc_resource-module20241211160209172862", "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b", "module_description" : "My First Hello World Module Description", "create_time" : "2024-12-11T08:03:37.345Z", "update_time" : "2024-12-11T08:03:37.345Z" }

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

功能介绍 获取私有模块元数据（ShowPrivateModuleMetadata） 获取当前私有模块的元数据信息 具体返回的信息见ShowPrivateModuleMetadataResponseBody，如果想查看私有模块下全部模块版本，请调用ListPrivateModuleVersions。 如果module_name和module_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 module_name String 私有模块（private-module）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 module_id String 私有模块（private-module）的唯一Id。 此Id由资源编排服务在生成模块的时候生成，为UUID。 由于私有模块名仅在同一时间下唯一，即允许用户先生成一个叫HelloWorld的私有模块，删除，再重新创建一个同名私有模块。 对于团队并行开发，用户可能希望确保，当前我操作的私有模块就是我以为的那个，而不是其他队友删除后创建的同名私有模块。因此，使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有模块所对应的Id都不相同，更新不会影响Id。如果给予的module_id和当前模块的Id不一致，则返回400 module_description String 私有模块（private-module）的描述。可用于客户识别被管理的私有模块。如果想要更新私有模块的描述，可以通过UpdatePrivateModuleMetadata API。 create_time String 私有模块（private-module）的生成时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。 update_time String 私有模块（private-module）的更新时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表6 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息

请求示例 删除资源栈，不保留资源 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 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表5 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg 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获取方式 stack_name 是 String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

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

响应示例 状态码：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" } ] }