代码托管 CODEARTS REPO-查询指定项目的Webhook列表:响应参数

时间:2024-10-26 11:09:47

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

接口调用时,响应错误。

取值范围:

无。

result

Array of Webhook object

参数解释:

接口调用的响应结果。

取值范围:

无。

status

String

参数解释:

调用此接口的响应状态。

取值范围:

  • success,表示接口调用成功。
  • failed,表示接口调用失败。
表5 Error

参数

参数类型

描述

code

String

参数解释:

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

message

String

参数解释:

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

表6 Webhook

参数

参数类型

描述

id

Integer

参数解释:

Webhook ID

取值范围:

最小值:1

最大值:2147483647

url

String

参数解释:

Webhook Url

取值范围:

不涉及。

push_events

Boolean

参数解释:

是否触发推送事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

tag_push_events

Boolean

参数解释:

是否触发Tag推送事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

merge_requests_events

Boolean

参数解释:

是否触发合并请求事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

note_events

Boolean

参数解释:

是否触发评论事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

token

String

参数解释:

Token(已加密)

取值范围:

不涉及。

name

String

参数解释:

Webhook 名称

取值范围:

必须为UTF-8字符

description

String

参数解释:

Webhook 描述

取值范围:

必须为UTF-8字符

token_type

String

参数解释:

Token 类型

取值范围:

  • X-Repo-Token
  • X-Gitlab-Token
  • X-Auth-Token

status

Boolean

参数解释:

Webhook 状态

取值范围:

  • 0:正常
  • -1:未启用

push_events_branch_regex_filter

String

参数解释:

分支过滤正则规则,勾选推送事件需配置

取值范围:

必须为正则表达式

created_at

String

参数解释:

Webhook 创建的时间

support.huaweicloud.com/api-codeartsrepo/zh-cn_topic_0000002006944112.html