文档首页/ 资源编排服务 RFS/ API参考/ API/ 资源编排-Hook/ 列举私有hook版本

更新时间：2025-10-14 GMT+08:00

查看PDF

列举私有hook版本

功能介绍

列举私有hook版本（ListPrivateHookVersions）

列举所选择的私有hook中所有的hook版本信息。

可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。
如果hook_name和hook_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。
如果hook下不存在hook版本，则返回空list。
如果hook不存在则返回404。
支持分页返回。如果响应中存在next_marker，则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中，在请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/private-hooks/{hook_name}/versions

表1 路径参数
参数	是否必选	参数类型	描述
hook_name	是	String	私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。最小长度：1 最大长度：128

表2 Query参数
参数	是否必选	参数类型	描述
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
sort_key	否	Array of strings	排序字段，仅支持给予create_time 最小长度：1
sort_dir	否	Array of strings	指定升序还是降序 asc - 升序 desc - 降序最小长度：1
marker	否	String	分页标记。当一页无法返回所有结果，上一次的请求将返回next_marker以指引还有更多页数，用户可以将next_marker中的值放到此处以查询下一页的信息。此marker只能用于与上一请求指定的相同参数的请求。不指定时默认从第一页开始查询。最小长度：1 最大长度：512
limit	否	Integer	每页返回的最多结果数量最小值：10 最大值：1000 缺省值：1000

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Client-Request-Id	是	String	用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
versions	Array of PrivateHookVersionSummary objects	私有hook version的列表。默认以创建时间降序排序。
page_info	PageInfo object	分页信息

表5 PrivateHookVersionSummary
参数	参数类型	描述
hook_name	String	私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。最小长度：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
hook_version	String	私有hook的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。最小长度：5 最大长度：128
hook_version_description	String	私有hook版本的描述。可用于客户识别创建私有hook的版本。注意：hook版本为不可更新（immutable），所以该字段不可更新，如果需要更新，请删除后重建。最小长度：0 最大长度：1024
create_time	String	私有Hook Version（private-hook-version）的生成时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。

表6 PageInfo
参数	参数类型	描述
next_marker	String	向后分页标识符。如果存在，则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中，在请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。
previous_marker	String	向前分页标识符。
current_count	Integer	本页显示的条目数量。

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	响应码最小长度：11 最大长度：11
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	响应码最小长度：11 最大长度：11
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	响应码最小长度：11 最大长度：11
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	响应码最小长度：11 最大长度：11
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	响应码最小长度：11 最大长度：11
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	响应码最小长度：11 最大长度：11
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

**表18** Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

请求示例

获取名为my-hello-world-hook-name的私有hook下的所有版本，以创建时间降序排序
```
GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions
```

获取名为my-hello-world-hook-name的私有hook下的所有版本，以创建时间升序排序

GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions?sort_key=create_time&sort_dir=asc

获取名为my-hello-world-hook-name的私有hook下的所有版本，并提供hook ID以校验是否与当前私有hook匹配，以创建时间升序排序
```
GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions?hook_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2&sort_key=create_time&sort_dir=asc
```

响应示例

状态码：200

列举私有hook版本成功

{
  "versions" : [ {
    "hook_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
    "hook_name" : "my-hello-world-hook-name",
    "hook_version" : "3.7.10",
    "version_description" : "my second hello world private hook version",
    "create_time" : "2024-01-01T00:00:00.000Z"
  }, {
    "hook_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
    "hook_name" : "my-hello-world-hook-name",
    "hook_version" : "3.7.9",
    "version_description" : "my first hello world private hook version",
    "create_time" : "2023-01-01T00:00:00.000Z"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null,
    "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks="
  }
}

状态码

状态码	描述
200	列举私有hook版本成功
400	用户请求非法
401	用户身份认证失败
403	用户无权限调用此API
404	私有hook不存在
429	请求数量过多
500	服务器内部错误

父主题： 资源编排-Hook

上一篇：创建私有hook版本

下一篇：删除私有hook版本

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问