文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 根据仓库id查询仓库某分支对应的提交列表
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

根据仓库id查询仓库某分支对应的提交列表

功能介绍

用户可根据仓库ID查询仓库某分支对应的提交列表。

调试

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

URI

GET /v1/repositories/{repository_id}/commits

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库ID，通过查询用户所有仓库接口查询仓库列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647。

默认值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

author

否

String

参数解释：

提交作者。

约束限制：

不涉及。

取值范围：

字符串长度为[0-2000]。

默认值：

不涉及。

begin_date

否

String

参数解释：

起始提交日期。

约束限制：

格式为yyyy-MM-dd。

取值范围：

不涉及。

默认值：

不涉及。

end_date

否

String

参数解释：

终止提交日期

约束限制：

格式为yyyy-MM-dd。

取值范围：

不涉及。

默认值：

不涉及。

message

否

String

参数解释：

提交信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

page_index

否

Integer

参数解释：

分页索引。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

1

page_size

否

Integer

参数解释：

每页数据量。

约束限制：

不涉及。

取值范围：

1-100

默认值：

20

path

否

String

参数解释：

文件路径。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

ref_name

是

String

参数解释：

分支或标签名，支持SHA格式。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

stat_format

否

String

参数解释：

提交的文件变更详情信息（不包含diff）。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

字符长度为[1,100000]。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释：

响应错误。

取值范围：

不涉及。

result

CommitList object

参数解释：

响应结果。

取值范围：

不涉及。

status

String

参数解释：

响应状态。

取值范围：

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

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

符合错误码格式字符串，长度[0,100]。

message

String

参数解释：

错误信息。

取值范围：

不涉及。
表6 CommitList

参数

参数类型

描述

commits

Array of Commit objects

参数解释：

提交列表

取值范围：

不涉及。

total

Integer

参数解释：

提交总数

取值范围：

不涉及。
表7 Commit

参数

参数类型

描述

author_email

String

参数解释：

作者邮箱

取值范围：

不涉及。

author_name

String

参数解释：

作者

取值范围：

不涉及。

authored_date

String

参数解释：

作者提交时间

取值范围：

不涉及。

committed_date

String

参数解释：

提交时间

取值范围：

不涉及。

committer_email

String

参数解释：

提交作者邮箱

取值范围：

不涉及。

committer_name

String

参数解释：

提交作者

取值范围：

不涉及。

format

Object

参数解释：

文件变更的详情信息，其格式由请求查询参数 stat_format 决定

取值范围：

不涉及。

id

String

参数解释：

提交对应的SHA id

取值范围：

不涉及。

message

String

参数解释：

提交的信息

取值范围：

不涉及。

parent_ids

Array of strings

参数解释：

父提交id

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v1/repositories/{repository_id}/commits

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 1,
    "commits" : [ {
      "id" : "a27fafa7d8da2dd55f691bef989226d22f50d8ce",
      "message" : "Initial commit",
      "parent_ids" : [ ],
      "authored_date" : null,
      "author_name" : "repo",
      "author_email" : "repo@example.com",
      "committed_date" : "2019-10-15 09:40:29",
      "committer_name" : "repo",
      "committer_email" : "repo@example.com"
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档