删除私有hook
功能介绍
删除私有hook（DeletePrivateHook）
删除某个私有hook以及私有hook下的全部hook版本
-
默认版本只能调用本API删除，除默认版本外的其它版本可以调用DeletePrivateHookVersion API删除。
-
若hook_name和hook_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。
请谨慎操作，删除私有hook将会删除该私有hook和该私有hook下的所有私有hook版本。
URI
DELETE /v1/private-hooks/{hook_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hook_name |
是 |
String |
私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。 最小长度：1 最大长度：128 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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。 最小长度：36 最大长度：36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Client-Request-Id |
是 |
String |
用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128 |
响应参数
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 最小长度：11 最大长度：11 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
请求示例
-
删除私有hook
DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name -
删除私有hook，并提供hook ID以校验是否与当前私有hook匹配
DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
删除私hook成功，无数据返回 |
|
400 |
用户请求非法 |
|
401 |
用户身份认证失败 |
|
403 |
用户无权限调用此API |
|
404 |
私有hook不存在 |
|
429 |
请求数量过多 |
|
500 |
服务器内部错误 |
