调用GetCompareDetail Compare接口_云效(Apsara Devops)-阿里云帮助中心

比较两个commit（branch和tag本质也是commit），返回两个commit之间的commits列表以及diff内容（可从diff内容中获取到文件变更树）。

调试

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

授权信息

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

请求语法

GET /repository/{repositoryId}/commits/compare/detail

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
repositoryId	long	是	代码库 ID	2369234
from	string	是	起始版本（指 commitId）	c9fb781f3d66ef6ee60bdd5c414f5106454b1426
to	string	是	截止版本（指 commitId）	b8f6f28520b1936aafe2e638373e19ccafa42b02
mergeBase	boolean	否	是否使用 merge-base 进行比较	false
maxDiffFile	integer	否	返回的最大文件数量说明限制最大安全返回的文件数量为 5000	5000
maxDiffByte	integer	否	返回的最大 diff 字节数说明限制最大返回的字节数为 24MB	24 * 1024 * 1024

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCode	string	错误码	SYSTEM_UNKNOWN_ERROR
errorMessage	string	错误信息	""
success	boolean	调用是否成功	true
result	object	返回结果
messages	array	说明列表
	string	说明内容	""
commits	object []	差异提交列表
id	string	提交 ID	b8f6f28520b1936aafe2e638373e19ccafa42b02
shortId	string	简短的提交 ID	b8f6f285
title	string	提交标题，提交的第一行内容	提交标题
message	string	提交内容	""
authorName	string	作者姓名	云效Codeup
authorEmail	string	作者邮箱	username@example.com
authoredDate	string	作者提交时间	2023-01-03T15:41:26+08:00
createdAt	string	创建时间	2023-01-03T15:41:26+08:00
committerName	string	提交人的姓名	云效CodeupCommitter
committerEmail	string	提交人的邮箱	username@example.com
committedDate	string	提交人的提交时间	2023-01-03T15:41:26+08:00
parentIds	array	父提交 ID
	string	父提交 Id	c9fb781f3d66ef6ee60bdd5c414f5106454b1426
author	object	作者信息
id	long	Codeup 用户 ID	21396
name	string	用户名称	云效
username	string	用户昵称	Codeup
state	string	状态可选值：active / blocked，默认值 active	active
avatarUrl	string	头像地址	https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
externUid	string	云效用户 ID	5f969843cd2214ba0e24327d
email	string	作者邮箱	username@example.com
websiteUrl	string	用户个人网页地址	“”
committer	object	提交人信息
id	long	Codeup 用户 ID	43910
name	string	用户名称	云效Committer
username	string	用户昵称	Codeup-commiter
state	string	状态可选值：active / blocked，默认值 active	active
avatarUrl	string	头像地址	https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
externUid	string	云效用户 ID	5f969843cd2214ba0e24327d
email	string	用户邮箱	username@example.com
websiteUrl	string	用户个人网页地址	""
commentsCount	long	评论数量	1
diffs	object []	Diff 文件内容
diff	string	diff 内容	--- /dev/null\n+++ b/mr_error.txt\n@@ -0,0 +1,3 @@\n+first\n+\n+提交2\n\\ No newline at end of file\n
newPath	string	新文件路径	new_test.txt
oldPath	string	旧文件路径	test.txt
aMode	string	旧路径的文件模式标识，包含文件类型、权限等信息，如 100644 为正常文件, 100755 为可执行文件	100644
bMode	string	新路径的文件模式标识，包含文件类型、权限等信息，如 100644 为正常文件, 100755 为可执行文件	100644
newFile	boolean	是否是新增文件	false
renamedFile	boolean	是否是重命名文件	false
deletedFile	boolean	是否是删除文件	false
isBinary	boolean	是否二进制文件	false
oldId	string	旧文件的 git object id	6c268061a546378276559c713d0ad377d4dsjfh
newId	string	新文件的 git object id	cb75846da2df3d3d7f290c3569236fcf3dd17224
isNewLfs	boolean	新文件是否是大文件（LFS）	false
isOldLfs	boolean	旧文件是否是大文件（LFS）	false

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "success": true,
  "result": {
    "messages": [
      "\"\""
    ],
    "commits": [
      {
        "id": "b8f6f28520b1936aafe2e638373e19ccafa42b02",
        "shortId": "b8f6f285",
        "title": "提交标题",
        "message": "\"\"",
        "authorName": "云效Codeup",
        "authorEmail": "username@example.com",
        "authoredDate": "2023-01-03T15:41:26+08:00",
        "createdAt": "2023-01-03T15:41:26+08:00",
        "committerName": "云效CodeupCommitter",
        "committerEmail": "username@example.com",
        "committedDate": "2023-01-03T15:41:26+08:00",
        "parentIds": [
          "c9fb781f3d66ef6ee60bdd5c414f5106454b1426"
        ],
        "author": {
          "id": 21396,
          "name": "云效",
          "username": "Codeup",
          "state": "active",
          "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
          "externUid": "5f969843cd2214ba0e24327d",
          "email": "username@example.com",
          "websiteUrl": "“”"
        },
        "committer": {
          "id": 43910,
          "name": "云效Committer",
          "username": "Codeup-commiter",
          "state": "active",
          "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
          "externUid": "5f969843cd2214ba0e24327d",
          "email": "username@example.com",
          "websiteUrl": "\"\""
        },
        "commentsCount": 1
      }
    ],
    "diffs": [
      {
        "diff": "--- /dev/null\\n+++ b/mr_error.txt\\n@@ -0,0 +1,3 @@\\n+first\\n+\\n+提交2\\n\\\\ No newline at end of file\\n",
        "newPath": "new_test.txt",
        "oldPath": "test.txt",
        "aMode": "100644",
        "bMode": "100644",
        "newFile": false,
        "renamedFile": false,
        "deletedFile": false,
        "isBinary": false,
        "oldId": "6c268061a546378276559c713d0ad377d4dsjfh",
        "newId": "cb75846da2df3d3d7f290c3569236fcf3dd17224",
        "isNewLfs": false,
        "isOldLfs": false
      }
    ]
  }
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-07-24

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。