九游平台/ 代码托管 codearts repo/ api参考/ / / 查询指定仓库的webhook
更新时间：2024-10-26 gmt 08:00

查询指定仓库的webhook-九游平台

功能介绍

获取仓库webhook

调试

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

uri

get /v1/repositories/{group_name}/{repository_name}/hooks

表1 路径参数

参数

是否必选

参数类型

描述

group_name

是

string

参数解释：

项目id（克隆地址中域名后面仓库名前的一段 示例：git@repo.alpha.devcloud.intest.com:2bc940921d964b86951950f5de1axxxx/testword.git 项目id：2bc940921d964b86951950f5de1axxxx）

约束限制：

不涉及。

取值范围：

只能由数字和字母组成，且长度为32个字符。

默认取值：

不涉及。

repository_name

是

string

参数解释：

仓库名

约束限制：

不涉及。

取值范围：

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成，且长度为[2-255]个字符。

默认取值：

不涉及。
表2 query参数

参数

是否必选

参数类型

描述

hook_id

否

string

参数解释：

webhook id

约束限制：

不涉及。

取值范围：

只能由数字组成，且范围为0-2147483647。

默认取值：

不涉及。

请求参数

表3 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

用户token。通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

error

error object

参数解释：

接口调用时，响应错误。

取值范围：

无。

result

repolisthook object

参数解释：

接口调用的响应结果。

取值范围：

无。

status

string

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表5 error

参数

参数类型

描述

code

string

参数解释：

调用此接口失败时返回的错误码。

取值范围：

  • ch.010117，表示指定仓库不存在，您需要检查请求参数是否有效。
  • ch.051020，表示查询仓库webhook失败，您需要检查webhook id是否正确。

message

string

参数解释：

调用此接口失败时返回的提示信息。
表6 repolisthook

参数

参数类型

描述

hooks

array of repohook objects

仓库webhook列表
表7 repohook

参数

参数类型

描述

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

错误码

请参见错误码。

父主题：

相关文档

网站地图