首页 云效 开发参考 API手册(新版) API目录 代码管理 合并请求 ListMergeRequestFilesReads - 查询合并请求变更文件已读情况

ListMergeRequestFilesReads - 查询合并请求变更文件已读情况

更新时间: 2024-02-27 19:42:42

查询合并请求变更文件的已读情况,主要获取变更文件的已读人列表。

调试

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

授权信息

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

请求语法

GET /api/v4/projects/merge_requests/diffs/files_read_infos

请求参数

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

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

60de7a6852743a5162b5f957
accessTokenstring

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

agp_4d57a6796b3626f52064ab1fba5384a5
repositoryIdentitystring

代码库 ID 或者全路径

2835387 或 codeup/codeup-demo
localIdlong

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

5
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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
successboolean

调用是否成功

true
errorCodestring

错误码

SYSTEM_UNKNOWN_ERROR
errorMessagestring

错误信息

""
resultobject []

返回结果列表

oldFilePathstring

新文件路径

text.txt
newFilePathstring

旧文件路径

text.txt
newFileboolean

是否是新增文件

true
renamedFilestring

是否是重命名文件

false
deletedFilestring

是否是删除文件

false
readUsersobject []

已读人列表

aliyunPkstring

阿里云账号 ID

204485087002425236
namestring

用户名称

codeup
usernamestring

用户登录名

test-codeup
statestring

用户状态

  • active:活跃
  • blocked:暂不可用
active
avatarUrlstring

用户头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
emailstring

用户邮箱

username@example.com

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "success": true,
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "result": [
    {
      "oldFilePath": "text.txt",
      "newFilePath": "text.txt",
      "newFile": true,
      "renamedFile": "false",
      "deletedFile": "false",
      "readUsers": [
        {
          "aliyunPk": "204485087002425236",
          "name": "codeup",
          "username": "test-codeup",
          "state": "active",
          "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
          "email": "username@example.com"
        }
      ]
    }
  ]
}

错误码

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

阿里云首页 云效 相关技术圈