更新时间:2025-08-20 GMT+08:00
分享

获取特定提交信息

功能介绍

获取特定提交信息

调试

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

URI

GET /v4/repositories/{repository_id}/repository/commits

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

sha

String

参数解释:

分支名、tag名、提交ID。

stats

Boolean

参数解释:

是否包含状态信息。

取值范围:

  • true,包含。

  • false,不包含。

默认取值:

true

show_code_changes

Boolean

参数解释:

是否包含代码变化信息。

取值范围:

  • true,包含。

  • false,不包含。

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

id

message

String

消息

parent_ids

Array of strings

父节点提交ID

authored_date

String

创建该分支的时间

author_name

String

创建者名称

author_email

String

创建者邮箱

committed_date

String

代码提交的日期和时间

committer_name

String

提交者名称

committer_email

String

提交者邮箱

open_gpg_verified

Boolean

是否打开gpg校验

verification_status

Integer

验证状态

取值范围:

0-1

gpg_primary_key_id

String

GPG公钥的标识符

name

String

用户名

gpg_nick_name

String

昵称

gpg_tenant_name

String

租户名

gpg_user_name

String

特定GPG用户相关的信息

short_id

String

短id

created_at

String

创建时间

title

String

标题

author_avatar_url

String

author_avatar_url

committer_avatar_url

String

committer_avatar_url

relate_url

Array of RelatedCommitSimpleDto objects

only for DevCloud

nick_name

String

标题

tenant_name

String

tenant_name

user_name

String

用户名

stats

CommitStatsDto object

参数解释:

统计信息。

取值范围:

不涉及。

status

String

参数解释:

状态。

取值范围:

不涉及。

last_pipeline

PipelineBasicDto object

参数解释:

最新流水线。

取值范围:

不涉及。

project_id

Integer

参数解释:

仓库ID。

取值范围:

不涉及。

merge_request

SimpleMergeRequestDetailDto object

参数解释:

合并请求信息。

取值范围:

不涉及。

code_changes

Array of SimpleDiffDto objects

参数解释:

代码变更内容。

取值范围:

不涉及。

表5 RelatedCommitSimpleDto

参数

参数类型

描述

related_id

String

关联工作项ID

related_url

String

关联工作URL

表6 CommitStatsDto

参数

参数类型

描述

additions

Integer

参数解释:

增加行数。

取值范围:

不涉及。

deletions

Integer

参数解释:

删除行数。

取值范围:

不涉及。

total

Integer

参数解释:

变更行数。

取值范围:

不涉及。

表7 PipelineBasicDto

参数

参数类型

描述

id

Integer

流水线ID

取值范围:

1-2147483647

web_url

String

流水线链接

sha

String

commit id

ref

String

分支

status

String

流水线状态,pending为排队,running为运行中,success为成功,failed为失败,canceled为取消,skipped为跳过,timedout为超时

枚举值:

  • pending

  • running

  • success

  • failed

  • canceled

  • skipped

  • timedout

表8 SimpleMergeRequestDetailDto

参数

参数类型

描述

id

Integer

参数解释:

合并请求id。

取值范围:

不涉及。

iid

Integer

参数解释:

合并请求iid。

取值范围:

不涉及。

title

String

参数解释:

标题。

取值范围:

不涉及。

description

String

参数解释:

描述。

取值范围:

不涉及。

source_branch

String

参数解释:

源分支。

取值范围:

不涉及。

target_branch

String

参数解释:

目标分支。

取值范围:

不涉及。

state

String

参数解释:

状态。

取值范围:

不涉及。

created_at

String

参数解释:

创建时间。

取值范围:

不涉及。

review_mode

String

参数解释:

审核模式。

取值范围:

不涉及。

author

UserBasicDto object

用户信息

merge_request_type

String

参数解释:

合并请求类型。

取值范围:

不涉及。

moderation_result

Boolean

参数解释:

送审结果。

取值范围:

  • true,成功。

  • false,失败

moderation_time

Long

参数解释:

送审时间时间戳。

取值范围:

不涉及。

moderation_status

Integer

参数解释:

送审状态码。

取值范围:

不涉及。

is_use_temp_branch

Boolean

参数解释:

是否使用临时分支。

取值范围:

  • true,使用。

  • false,不使用

表9 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

用户状态

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

表10 SimpleDiffDto

参数

参数类型

描述

added_line

Integer

参数解释:

增加行数。

取值范围:

不涉及。

deleted_line

Integer

参数解释:

删除行数。

取值范围:

不涉及。

path

String

参数解释:

路径。

取值范围:

不涉及。

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

响应示例

状态码:200

ok

{
  "id" : "d9586a73454ecceb12a53800c293174d601bd4e1",
  "message" : "1234test",
  "parent_ids" : [ "ce25367f2d97093130bc7822ef48d1bb5bd18d86" ],
  "authored_date" : "2025-01-22T02:56:21.000Z",
  "author_name" : "example",
  "author_email" : "example@example.com",
  "committed_date" : "2025-01-22T02:56:21.000Z",
  "committer_name" : "example",
  "committer_email" : "example@example.com",
  "open_gpg_verified" : null,
  "verification_status" : 0,
  "gpg_primary_key_id" : null,
  "name" : null,
  "gpg_nick_name" : null,
  "gpg_tenant_name" : null,
  "gpg_user_name" : null,
  "short_id" : "131ef0cb",
  "created_at" : "2025-01-22T02:56:21.000Z",
  "title" : "1234test",
  "author_avatar_url" : "https://example.com/w3lab/rest/yellowpage/face/30042607/120",
  "committer_avatar_url" : "https://example.com/w3lab/rest/yellowpage/face/30042607/120",
  "relate_url" : null,
  "nick_name" : "test",
  "tenant_name" : "test",
  "user_name" : "test",
  "stats" : {
    "additions" : 0,
    "deletions" : 0,
    "total" : 0
  },
  "status" : null,
  "last_pipeline" : null,
  "project_id" : 2112029050,
  "merge_request" : null,
  "code_changes" : null
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

ok

401

Unauthorized

错误码

请参见错误码

相关文档