文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Ref/ 查看文件树
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

查看文件树

功能介绍

查看文件树

调试

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

URI

GET /api/v4/repositories/{repository_id}/repository/logs-tree

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

ref

否

String

参数解释：

引用，可以是分支名称、tag名称或者commitId，如果不传则为默认分支。

取值范围：

字符串长度不少于1，不超过2000。

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of LogTreeDto objects

文件树列表
表5 LogTreeDto

参数

参数类型

描述

name

String

参数解释：

文件名

path

String

参数解释：

路径

type

String

参数解释：

文件类型

commit

RepositoryCommitDto object

参数解释：

最近提交信息

blob_id

String

参数解释：

文件id

submodule_url

String

参数解释：

子模块url地址

is_limited

Boolean

参数解释：

文件是否受限

submodule_link

String

参数解释：

子模块链接

md5

String

参数解释：

文件md5

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

gpg校验状态

取值范围：

0-10

gpg_primary_key_id

String

gpg验证key

name

String

名称

gpg_nick_name

String

gpg昵称

gpg_tenant_name

String

gpg企业名称

gpg_user_name

String

gpg用户名

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

无

响应示例

状态码：200

文件树信息

[ {
  "name" : "eer",
  "path" : "eer",
  "type" : "tree",
  "commit" : {
    "id" : "188680745edb3955***a6f9b110019c145955",
    "message" : "rr",
    "parent_ids" : [ "456ac4f94816****deec9a95a2faf33f199fc" ],
    "authored_date" : "2024-10-29T03:02:10.000Z",
    "author_name" : "****",
    "author_email" : "aan@example.com",
    "committed_date" : "2024-10-29T03:02:10.000Z",
    "committer_name" : "****",
    "committer_email" : "aa@example.com",
    "open_gpg_verified" : null,
    "verification_status" : null,
    "gpg_primary_key_id" : null,
    "name" : null,
    "gpg_nick_name" : null,
    "gpg_tenant_name" : null,
    "gpg_user_name" : null
  },
  "blob_id" : "****",
  "submodule_url" : null,
  "is_limited" : false,
  "submodule_link" : null,
  "md5" : "****",
  "nick_name" : "****",
  "tenant_name" : "****",
  "user_name" : "****"
} ]

状态码：401

Unauthorized

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

状态码：403

Bad Request

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

状态码

状态码

描述

200

文件树信息

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： Ref

相关文档