文档

GetMergeRequestChangeTree - 查询合并请求Diff统计信息

查询合并请求的Diff统计信息,包括总变更文件树、总新增行、总删减行以及每个文件的新增行与删减行。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v4/projects/merge_requests/diffs/change_tree

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdentitystring

代码库 ID 或者全路径

2835387 或 codeup/codeup-demo
localIdlong

合并请求局部 ID,表示代码库下的第几个合并请求

7
fromPatchSetBizIdstring

合并目标的版本业务 ID

说明 关于 from 和 to,在合并请求以及比较相关的接口中,from 和 to 与常识是相反的,即 from 应该是合并目标,to 才是合并源,该顺序符合实际 Git 执行时的顺序,页面 UI 的源和目标实际上是经过处理后的,才会符合直觉。
5e733626d53f4b04a6aa0e23d4ff72b8
toPatchSetBizIdstring

合并源的版本业务 ID

说明 关于 from 和 to,在合并请求以及比较相关的接口中,from 和 to 与常识是相反的,即 from 应该是合并目标,to 才是合并源,该顺序符合实际 Git 执行时的顺序,页面 UI 的源和目标实际上是经过处理后的,才会符合直觉。
513fcfd81a9142d2bb0db4f72c0aa15b

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F
successboolean

调用是否成功

true
errorCodestring

错误码

SYSTEM_UNKNOWN_ERROR
errorMessagestring

错误信息

""
resultobject

返回结果

changedFilesCountlong

总变更文件数量

20
totalAddLineslong

总新增行

100
totalDelLineslong

总删除行

50
changedFilesInfosobject []

变更文件信息列表

newPathstring

新文件路径

test.txt
oldPathstring

旧文件路径

test.txt
newFileboolean

是否是新增文件

true
renamedFileboolean

是否是重命名文件

false
deletedFileboolean

是否是删除文件

false
binaryFileboolean

是否是二进制文件

false
addLineslong

变更文件新增行数

10
delLineslong

变更文件删除行数

0

示例

正常返回示例

JSON格式

{
  "requestId": "HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F",
  "success": true,
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "result": {
    "changedFilesCount": 20,
    "totalAddLines": 100,
    "totalDelLines": 50,
    "changedFilesInfos": [
      {
        "newPath": "test.txt",
        "oldPath": "test.txt",
        "newFile": true,
        "renamedFile": false,
        "deletedFile": false,
        "binaryFile": false,
        "addLines": 10,
        "delLines": 0
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈