文档首页> 代码托管 CodeArts Repo> API参考> API> Commit> 查询某个仓库的提交信息
更新时间：2024-01-16 GMT+08:00
查看PDF
分享

查询某个仓库的提交信息

功能介绍

根据仓库短ID获取提交信息，支持根据文件路径，查询这个路径下所有的commits列表。

调试

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

URI

GET /v2/projects/{repo_id}/repository/commits

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

是

Integer

仓库短id
表2 Query参数

参数

是否必选

参数类型

描述

ref_name

否

String

仓库的branch名或tag名，如果为空则查询默认分支

since

否

String

在此日期之后或当天提交，格式 YYYY-MM-DDTHH:MM:SSZ

until

否

String

在此日期之前或当天提交，格式 YYYY-MM-DDTHH:MM:SSZ

path

否

String

文件路径

all

否

Boolean

是否检索仓库中每个提交

with_stats

否

Boolean

有关每个提交的统计信息是否添加到响应中

page

否

Integer

页码

最小值：1

最大值：2147483647

per_page

否

Integer

每页条目数

最小值：1

最大值：100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

Array of CommitInfo objects

提交列表

status

String

响应状态
表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表6 CommitInfo

参数

参数类型

描述

id

String

提交对应的SHA id

short_id

String

提交对应的短SHA id

title

String

提交标题

author_name

String

作者

author_email

String

作者邮箱

committer_name

String

提交作者

committer_email

String

提交作者邮箱

created_at

String

创建时间

message

String

提交信息

parent_ids

Array of strings

父提交id

committed_date

String

提交时间

authored_date

String

作者提交时间

请求示例

GET https://{endpoint}/v2/projects/859341/repository/commits

响应示例

状态码： 200

OK

{
  "result" : [ {
    "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b",
    "title" : "some commit message",
    "message" : "some commit message",
    "short_id" : "85a0a9d5",
    "author_name" : "repo",
    "author_email" : null,
    "committer_name" : "repo",
    "committer_email" : null,
    "created_at" : "2021-09-26T03:44:51.000Z",
    "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ],
    "committed_date" : "2021-09-26T03:44:51.000Z",
    "authored_date" : null
  }, {
    "id" : "5c114bb316dff4d4a046e09a5c44c816f2433140",
    "title" : "更新README.md",
    "message" : "更新README.md",
    "short_id" : "5c114bb3",
    "author_name" : "repo",
    "author_email" : null,
    "committer_name" : "repo",
    "committer_email" : null,
    "created_at" : "2021-08-26T12:02:58.000Z",
    "parent_ids" : [ "646fc72bd87eb02e1e84bf3b82179c7f6d22c2c2" ],
    "committed_date" : "2021-08-26T12:02:58.000Z",
    "authored_date" : null
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Commit
分享：

    相关文档

    相关产品