文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 获取变更文件列表
更新时间：2024-11-08 GMT+08:00
查看PDF
分享

获取变更文件列表

功能介绍

获取变更文件列表。

调试

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

URI

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

表1 Query参数

参数

是否必选

参数类型

描述

repository_id

是

String

参数解释：

仓库短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及

merge_request_iid

否

Integer

参数解释：

合并请求的短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及

view

否

String

参数解释：

合并请求的短id

约束限制：

无

取值范围：

simple

默认取值：

不涉及

commit_id

否

String

参数解释：

提交ID。

约束限制：

无

取值范围：

无

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Object Error

响应错误

result

MergeChangesTreesDto object

参数解释：

相应结果。

status

String

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败
表4 响应Error参数

参数

参数类型

描述

code

String

参数解释：

调用此接口失败时返回的错误码。

取值范围：

  • CH.10000，系统繁忙，请稍后再试。

message

String

参数解释：

调用此接口失败时返回的提示信息。

取值范围：

  • “系统繁忙，请稍后再试”。
表5 MergeChangesTreesDto

参数

参数类型

描述

tree

MergeChangesTrees objects

参数解释：

文件树。
表6 MergeChangesTrees

参数

参数类型

描述

title

String

参数解释：

分段路径。

level

Integer

参数解释：

路径级别。

file_path

String

参数解释：

当前级别全路径。

file_type

String

参数解释：

文件类型。

请求示例

GET https://{endpoint}/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes-trees

响应示例

状态码： 200

OK 
{
    "result": {
        "tree": [{
            "title": "qwdasasdfasd",
            "level": 1,
            "file_path": "qwdasasdfasd",
            "file_type": "file"
        }]
    },
    "status": "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档