资源编排服务 RFS-创建私有hook:请求参数
下载资源编排服务 RFS用户手册完整版
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Client-Request-Id |
是 |
String |
用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hook_name |
是 |
String |
私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。 |
|
hook_version |
是 |
String |
私有hook的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。 |
|
hook_description |
否 |
String |
私有hook的描述。可用于客户识别创建的私有hook。可通过UpdatePrivateHook API更新私有hook的描述。 |
|
hook_version_description |
否 |
String |
私有hook版本的描述。可用于客户识别创建私有hook的版本。注意：hook版本为不可更新（immutable），所以该字段不可更新，如果需要更新，请删除后重建。 |
|
configuration |
否 |
configuration object |
私有hook配置项，可以指定私有hook生效的目标资源栈以及私有hook校验失败后资源栈的行为。可通过UpdatePrivateHook API更新私有hook配置项。 |
|
policy_uri |
否 |
String |
策略文件的OBS地址。内容仅支持OPA开源引擎识别的，以Rego（https://www.openpolicyagent.org/docs/latest/policy-language/）语言编写的策略模板。 请确保OBS地址所在局点与使用 RFS 服务局点一致。 策略文件当前支持单文件或zip压缩包，单文件需要以".rego"结尾，压缩包当前只支持zip格式，文件需要以.zip结尾。 关于策略文件的校验要求如下：
policy_uri和policy_body必须有且只有一个存在 |
|
policy_body |
否 |
String |
策略内容。仅支持OPA开源引擎识别的，以Rego（https://www.openpolicyagent.org/docs/latest/policy-language/）语言编写的策略模板。 policy_body和policy_uri 必须有且只有一个存在 |
