文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 获取合并请求文件变更列表树
更新时间:2025-07-15 GMT+08:00
分享

获取合并请求文件变更列表树

功能介绍

获取合并请求文件变更列表树

调试

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

URI

GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes-trees

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

merge_request_iid

Integer

参数解释:

合并请求 iid。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

approval_user_id

Integer

参数解释:

审核人ID。

commit_id

String

参数解释:

commit ID。

取值范围:

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

from_diff_id

Integer

参数解释:

文件变更对比源版本id

to_diff_id

Integer

参数解释:

文件变更对比目标版本id

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 ChangesTreeDto objects

合并请求文件变更列表详情

表5 ChangesTreeDto

参数

参数类型

描述

can_show_my_approval_files

Boolean

参数解释:

展示审核文件。

tree

Array of ChangesTreeObjectDto objects

参数解释:

变更树。

表6 ChangesTreeObjectDto

参数

参数类型

描述

title

String

参数解释:

变更文件名。

level

Integer

参数解释:

文件层级。

file_path

String

参数解释:

文件路径。

file_type

String

参数解释:

文件类型。

diff

ChangesTreeObjectDiffDto object

参数解释:

文件变更对比。

items

Array of ChangesTreeObjectDto objects

参数解释:

子文件变更。

表7 ChangesTreeObjectDiffDto

参数

参数类型

描述

diff

String

参数解释:

变更内容。

new_path

String

参数解释:

变更新路径。

old_path

String

参数解释:

变更旧。

a_mode

String

参数解释:

旧文件权限。

b_mode

String

参数解释:

新文件权限。

new_file

Boolean

参数解释:

是否是新文件。

renamed_file

Boolean

参数解释:

是否是改名文件。

deleted_file

Boolean

参数解释:

是否是删除文件。

too_large

Boolean

参数解释:

是否内容过长。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

/v4/repositories/2111976239/merge-requests/6/changes

响应示例

状态码:200

OK

{
  "can_show_my_approval_files" : null,
  "tree" : [ {
    "title" : "test2",
    "level" : 1,
    "file_path" : "test2",
    "file_type" : "file",
    "diff" : {
      "diff" : "",
      "new_path" : "test2",
      "old_path" : "test2",
      "a_mode" : "0",
      "b_mode" : "100644",
      "new_file" : true,
      "renamed_file" : false,
      "deleted_file" : false,
      "too_large" : false
    }
  } ]
}

状态码:400

Bad Request

{
  "error_code" : "CH.00405011",
  "error_msg" : "错误请求"
}

状态码:401

Unauthorized

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档