获取仓库动态
功能介绍
获取仓库动态(当前仅开放推送动态)
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/events
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
author_id |
否 |
Integer |
参数解释: 操作者id。 取值范围: 1-2147483647 |
filter |
否 |
String |
参数解释: 动态类型。 约束限制:
默认取值: all 枚举值:
|
before |
否 |
String |
参数解释: 开始日期。 |
after |
否 |
String |
参数解释: 结束日期。 |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
参数解释: 当前请求的结果总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of RepositoryPushEventDto objects |
参数解释: 推送动态。 |
参数 |
参数类型 |
描述 |
---|---|---|
action_name |
String |
参数解释: 操作名称。
枚举值:
|
author |
RepositoryEventAuthorDto object |
参数解释: 触发者信息。 |
author_id |
Integer |
参数解释: 触发者ID。 取值范围: 1-2147483647 |
author_username |
String |
参数解释: 触发者名称。 |
created_at |
String |
参数解释: 创建时间。 |
repository_id |
Integer |
参数解释: 仓库ID。 取值范围: 1-2147483647 |
repository_name |
String |
参数解释: 仓库名。 |
push_data |
PushEventPayloadDto object |
参数解释: 推送信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 用户名称。 |
username |
String |
参数解释: 用户名。 |
state |
String |
参数解释: 状态。 |
avatar_url |
String |
参数解释: 头像地址。 |
name_cn |
String |
参数解释: 中文名。 |
nick_name |
String |
参数解释: 昵称。 |
tenant_name |
String |
参数解释: 租户名。 |
参数 |
参数类型 |
描述 |
---|---|---|
commit_count |
Integer |
参数解释: 提交数量。 取值范围: 1-2147483647 |
action |
String |
参数解释: 操作类型。 |
ref_type |
String |
参数解释: ref类型。 |
commit_from |
String |
参数解释: 源Commit。 |
commit_to |
String |
参数解释: 目标Commit。 |
ref |
String |
参数解释: 分支。 |
commit_title |
String |
参数解释: 提交标题。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repositories/10001/events
响应示例
状态码:200
仓库动态列表
[ { "action_name" : "pushed new", "author" : { "id" : 9124, "name" : "dev_test", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "avatar_url" : "", "name_cn" : "dev_test", "nick_name" : "dev", "tenant_name" : "test_tenant" }, "author_id" : 9124, "author_username" : "c369c68f1ff84679b5a8ed904d8bff1c", "created_at" : "2024-08-21T06:21:22.000Z", "repository_id" : 2111694664, "repository_name" : "lhtest00002/RepoProtal", "push_data" : { "commit_count" : 0, "action" : "created", "ref_type" : "branch", "commit_from" : null, "commit_to" : "17933c207b320a74dc10af80e0d9d9720a90dd5e", "ref" : "asdsada#fasdasda", "commit_title" : null } } ]
状态码:401
Unauthorized
{ "error_code" : "CH.00000001", "error_msg" : "未识别到用户认证信息" }
状态码:403
Bad Request
{ "error_code" : "CH.00401008", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码:404
Not Found
{ "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
仓库动态列表 |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。