# 查询指定仓库的Webhook（废弃） #### 功能介绍 获取仓库Webhook ![](https://support.huaweicloud.com/api-codeartsrepo/public_sys-resources/note_3.0-zh-cn.png) 当前API已经废弃，请使用[获取仓库下Webhook列表](https://support.huaweicloud.com/api-codeartsrepo/ListRepositoryWebhooks.html)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeHub/doc?api=ListHooks)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v1/repositories/{group_name}/{repository_name}/hooks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_name | 是 | String | **参数解释：** 项目ID（克隆地址中域名后面仓库名前的一段 示例：git@example.com:2bc940921d964b86951950f5de1axxxx/testword.git 项目ID：2bc940921d964b86951950f5de1axxxx） **约束限制：** 不涉及。 **取值范围：** 只能由数字和字母组成，且长度为32个字符。 **默认取值：** 不涉及。 | | repository_name | 是 | String | **参数解释：** 仓库名 **约束限制：** 不涉及。 **取值范围：** 只能由中文字符、英文字母、数字及"_"、"-"、"."组成，且长度为\[2-255\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | hook_id | 否 | String | **参数解释：** Webhook ID **约束限制：** 不涉及。 **取值范围：** 只能由数字组成，且范围为0-2147483647。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释：** 接口调用时，响应错误。 **取值范围：** 不涉及。 | | result | [RepoListHook] object | **参数解释：** 接口调用的响应结果。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 调用此接口的响应状态。 **取值范围：** - success，表示接口调用成功。 - failed，表示接口调用失败。 | 表5Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 调用此接口失败时返回的错误码。 **取值范围：** - CH.010117，表示指定仓库不存在，您需要检查请求参数是否有效。 - CH.051020，表示查询仓库Webhook失败，您需要检查Webhook ID是否正确。 | | message | String | **参数解释：** 调用此接口失败时返回的提示信息。 | 表6RepoListHook | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hooks | Array of [RepoHook] objects | 仓库Webhook列表 | 表7RepoHook | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | Webhook ID | | project_id | Integer | 仓库ID | | created_at | String | Webhook创建的时间 | | enable_ssl_verification | Boolean | 是否使用ssl验证 | | push_events | Boolean | 是否触发push_events事件 | | tag_push_events | Boolean | 是否触发tag_push_events事件 | | repository_update_events | Boolean | 是否触发repository_update_events事件 | | merge_requests_events | Boolean | 是否触发merge_requests_events事件 | | issues_events | Boolean | 是否触发issues_events事件 | | note_events | Boolean | 是否触发note_events事件 | | pipeline_events | Boolean | 是否触发pipeline_events事件 | | wiki_page_events | Boolean | 是否触发wiki_page_events事件 | #### 请求示例 ``` GET https://{endpoint}/v1/repositories/{group_name}/{repository_name}/hooks ``` #### 响应示例 **状态码： 200** OK ``` { "result" : { "hooks" : [ { "id" : 2111600786, "project_id" : 2111615967, "created_at" : "2021-11-09 16:35:15", "enable_ssl_verification" : false, "push_events" : true, "tag_push_events" : false, "repository_update_events" : false, "merge_requests_events" : false, "issues_events" : false, "note_events" : false, "pipeline_events" : false, "wiki_page_events" : false } ] }, "status" : "success" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见错误码。