资源编排服务 RFS-更新私有hook元数据:请求参数

时间:2025-03-10 20:33:59

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

hook_description

String

私有hook的描述。可用于客户识别创建的私有hook。可通过UpdatePrivateHook API更新私有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。

default_version

String

私有hook的默认版本号。版本号必须遵循语义化版本号(Semantic Version),为用户自定义。

configuration

configuration object

私有hook配置项,可以指定私有hook生效的目标资源栈以及私有hook校验失败后资源栈的行为。可通过UpdatePrivateHook API更新私有hook配置项。

表4 configuration

参数

是否必选

参数类型

描述

target_stacks

String

指定私有hook生效的目标资源栈,有效值为NONE或ALL。

NONE:指定此私有hook不会作用于任何资源栈

ALL:指定此私有hook将会应用于账号下的所有资源栈

failure_mode

String

指定私有hook校验失败后的行为,有效值为FAIL或WARN。

FAIL:指定此私有hook校验失败后资源栈将停止部署,资源栈状态将更新为DEPLOYMENT_FAILED。

WARN:指定此私有hook校验失败后仅通过资源栈事件展示警告消息,但不影响资源栈部署。

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