文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ File/ 获取当前文件上级树结构
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取当前文件上级树结构

功能介绍

获取当前文件上级树结构

调试

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

URI

GET /v4/repositories/{repository_id}/repository/upper-files-tree

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

file_path

否

String

参数解释：

文件路径。

取值范围：

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

ref_name

否

String

参数解释：

分支或者tag名称。

约束限制：

不支持以 - . refs/heads/ refs/remotes/ 开头，不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符，不支持以. / .lock结尾。

取值范围：

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

默认取值：

仓库默认分支。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TreeDto objects

获取当前文件上级树结构
表5 TreeDto

参数

参数类型

描述

id

String

参数解释：

提交ID。

取值范围：

不涉及。

name

String

参数解释：

文件名称。

取值范围：

不涉及。

type

String

参数解释：

文件结构。

取值范围：

  • commit, 子模块。

  • tree, 目录。

  • blob, 文件

枚举值：

  • commit

  • tree

  • blob

path

String

参数解释：

文件路径。

取值范围：

不涉及

level

Integer

参数解释：

当前所在目录层级。

取值范围：

不涉及

isShownDropDown

Boolean

参数解释：

是否下拉。

取值范围：

  • false, 不下拉。

  • true, 下拉

folder

Boolean

参数解释：

是否折叠。

取值范围：

  • false, 不折叠。

  • true, 折叠。

children

Array of TreeDto objects

子节点

submodule_link

String

参数解释：

子模块连接。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112029050/repository/upper-files-tree

响应示例

状态码：200

文件溯源信息

[ {
  "id" : "39f26b16fdff0242abc4ac3022cb0f1f88c6a523",
  "name" : "123",
  "type" : "tree",
  "path" : "123",
  "level" : -1,
  "isShownDropDown" : false,
  "folder" : false,
  "children" : null,
  "submodule_link" : null
}, {
  "id" : "624c18a4353c2789ada229459ae1aa2f47f3d2dc",
  "name" : "1234",
  "type" : "tree",
  "path" : "1234",
  "level" : -1,
  "isShownDropDown" : false,
  "folder" : false,
  "children" : null,
  "submodule_link" : null
} ]

状态码：401

Unauthorized

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

状态码：403

Bad Request

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

状态码

状态码

描述

200

文件溯源信息

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： File

相关文档