获取项目下指定Webhook的日志列表
功能介绍
获取项目下指定Webhook的日志列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/projects/{project_id}/hooks/{hook_id}/logs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
hook_id |
是 |
Integer |
参数解释: Webhook id。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
repository_id |
否 |
Integer |
参数解释: 仓库ID 取值范围: 1-2147483647 |
uuid |
否 |
String |
参数解释: Webhook每次发送消息时会在请求体中带上uuid字段。uuid具有唯一性,合并请求相关的Webhook事件中的uuid会包含合并请求iid。此处可以使用完整的uuid或者合并请求iid。 约束限制: 可选。 取值范围: 字符串长度不少于1,不超过100。 默认取值: 不涉及。 |
created_after |
否 |
String |
参数解释: 检索执行时间段的起始时间 |
created_before |
否 |
String |
参数解释: 检索执行时间段的结束时间 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
参数解释: 当前请求的结果总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of WebhookLogExtendDto objects |
参数解释: Webhook执行日志数据,带仓库信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: Webhook 日志id。 取值范围: 1-2147483647 |
web_hook_id |
Integer |
参数解释: Webhook id。 取值范围: 1-2147483647 |
trigger |
String |
参数解释: 触发类型。 |
url |
String |
参数解释: 请求地址。 |
response_status |
String |
参数解释: 响应状态,默认是响应码,如果webhook地址未返回或者其他异常情况,则记录为internal error |
execution_duration |
Double |
参数解释: 响应耗时,单位是秒 取值范围: 0-300 |
uuid |
String |
参数解释: Webhook每次发送消息的时候,会在请求体中带上uuid字段,此处为该记录的uuid字段 |
created_at |
String |
参数解释: 创建时间。 |
updated_at |
String |
参数解释: 更新时间。 |
repository |
WebhookRepositoryDto object |
参数解释: Webhook执行日志关联的仓库基本信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 仓库ID 取值范围: 1-2147483647 |
namespace |
String |
参数解释: 仓库路径 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/hooks/1/logs
响应示例
状态码:200
OK
[ { "id" : 664135687, "web_hook_id" : 990085, "trigger" : "push_hooks", "url" : "http://demo.com", "response_status" : "200", "execution_duration" : 0.01, "created_at" : "2025-05-23T14:54:37.780+08:00", "updated_at" : "2025-05-23T14:54:37.780+08:00", "uuid" : "161f36e5-fe6c-428d-9c17-1ce833f810e6", "repository" : { "id" : 1, "namespace" : "group/hello" } } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。