文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ WebHook/ 查询指定仓库的webhook
更新时间:2023-08-31 GMT+08:00

查询指定仓库的webhook

功能介绍

获取仓库webhook

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

group_name

String

组名(克隆地址中域名后面仓库名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 )

repository_name

String

仓库名

表2 Query参数

参数

是否必选

参数类型

描述

hook_id

String

hook id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

RepoListHook object

响应结果

status

String

响应状态

表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息

表6 RepoListHook

参数

参数类型

描述

hooks

Array of RepoHook objects

hook列表

表7 RepoHook

参数

参数类型

描述

build_events

Boolean

是否触发build_events事件

created_at

String

仓库统计创建的时间

enable_ssl_verification

Boolean

是否使用ssl验证

id

Integer

hook id

issues_events

Boolean

是否触发issues_events事件

merge_requests_events

Boolean

是否触发merge_requests_events事件

note_events

Boolean

是否触发note_events事件

pipeline_events

Boolean

是否触发pipeline_events事件

project_id

Integer

仓库id

push_events

Boolean

是否触发push_events事件

repository_update_events

Boolean

是否触发repository_update_events事件

tag_push_events

Boolean

是否触发tag_push_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

错误码

请参见错误码