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

查看分支文件列表

功能介绍

查看分支文件列表

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

ref

否

String

参数解释：

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

取值范围：

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

path

否

String

参数解释：

文件路径。

取值范围：

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

recursive

否

Boolean

参数解释：

是否递归查询

默认取值：

false

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 响应Header参数

参数

参数类型

描述

X-Total

Integer

查看分支文件列表
表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TreeObjectDto objects

文件列表
表6 TreeObjectDto

参数

参数类型

描述

id

String

文件唯一标识

name

String

文件名称

type

String

对象类型

path

String

文件路径

mode

String

模式结构

submodule_link

String

子模块链接

submodule_branch

String

子模块分支

md5

String

md5值

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/repository/trees

响应示例

状态码：200

查看分支文件列表

[ {
  "id" : "*****",
  "name" : "images",
  "type" : "tree",
  "path" : "images",
  "mode" : "040000",
  "submodule_link" : null,
  "submodule_branch" : null,
  "md5" : "59b514174bffe4ae402b3d63aad79fe0"
} ]

状态码：401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码：403

Bad Request

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

状态码：404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

查看分支文件列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： Repository

相关文档