文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ File/ 获取文件追溯信息
更新时间:2025-07-15 GMT+08:00
分享

获取文件追溯信息

功能介绍

获取文件追溯信息

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

file_path

String

参数解释:

文件路径。

取值范围:

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

sha

String

参数解释:

分支名、tag名、提交ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of BlameDto objects

溯源信息

表5 BlameDto

参数

参数类型

描述

commit

RepositoryCommitDto object

提交

avatar_url

String

参数解释:

头像链接

取值范围:

不涉及。

lines

Array of LineContentDto objects

行信息

nick_name

String

参数解释:

昵称

取值范围:

不涉及。

tenant_name

String

参数解释:

租户名称。

取值范围:

不涉及。

user_name

String

参数解释:

用户名。

取值范围:

不涉及。

表6 RepositoryCommitDto

参数

参数类型

描述

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用户相关的信息

表7 LineContentDto

参数

参数类型

描述

lineNO

Integer

参数解释:

文件行数

取值范围:

1-2147483647

content

String

参数解释:

该行对应内容

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112029050/repository/blame?sha=master&file_path=dad

响应示例

状态码:200

文件溯源信息

[ {
  "commit" : {
    "description" : "提交信息",
    "id" : "92a2693452eea84d3c07850310a63028a82173d4",
    "message" : "更新 dad",
    "parent_ids" : "[test01,test02]",
    "authored_date" : "2025-06-14T06:53:58.000Z",
    "author_name" : "adad",
    "author_email" : "aa@example.com",
    "committed_date" : "2025-06-14T06:53:58.000Z",
    "committer_name" : "adad",
    "committer_email" : "aa@example.com",
    "open_gpg_verified" : true,
    "verification_status" : 1,
    "gpg_primary_key_id" : "87E44B5F42161434",
    "name" : "eamll.com",
    "gpg_nick_name" : null,
    "gpg_tenant_name" : null,
    "gpg_user_name" : null
  },
  "avatar_url" : "",
  "lines" : [ {
    "lineNO" : 2,
    "content" : "adad"
  }, {
    "lineNO" : 3,
    "content" : "dad2"
  } ],
  "nick_name" : "aaa",
  "tenant_name" : "aaaa",
  "user_name" : "aaaaa"
} ]

状态码:401

Unauthorized

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

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码

状态码

描述

200

文件溯源信息

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档