调用GetBranchInfo查询分支信息_云效(Apsara Devops)-阿里云帮助中心

查询代码库分支的信息。

调试

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

授权信息

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

请求语法

GET /repository/{repositoryId}/branches/detail

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5fbe3118672533690be72b12
accessToken	string	否	个人访问令牌。使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段	f0b1e61db5961df5975a93f9129d2513
repositoryId	long	是	代码库 ID	2334743
branchName	string	是	分支名称	master

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	6177543A-8D54-5736-A93B-E0195A1512CB
errorMessage	string	错误信息	""
errorCode	string	错误码	Openapi.RequestError
success	boolean	请求是否成功	true
result	object	返回结果
name	string	分支名称	master
protected	string	是否是保护分支	false
commit	object	分支最近一次提交信息
id	string	提交 ID	e0297d8fb0393c833a8531e7cc8832739e3cba6d
shortId	string	简短的提交 ID	e0297d8f
title	string	提交标题，提交的第一行内容	修改main.txt文件
authorName	string	作者姓名	阿里云云效
authorEmail	string	作者邮箱	username@example.com
createdAt	string	创建时间	2022-03-18 10:00:00
message	string	提交内容	修改main.txt文件
authoredDate	string	作者提交时间	2022-03-18 08:00:00
committedDate	string	提交人的提交时间	2022-03-18 09:00:00
committerEmail	string	提交人的邮箱	username@example.com
committerName	string	提交人的姓名	阿里云云效Committer
parentIds	array	父提交 ID 列表
	string	父提交 ID	de02b625ba8488f92eb204bcb3773a40c1b4ddac
author	object	作者信息
id	long	Codeup 的用户 ID	28056
name	string	作者名称	codeup-test
username	string	用户昵称	testtest
state	string	状态可选值：active / blocked，默认值 active	active
avatarUrl	string	头像地址	https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
email	string	用户邮箱	username@example.com
committer	object	提交人信息
id	long	Codeup 的用户 ID	5035
name	string	提交人的姓名	codeup-commit
username	string	用户昵称	commitcommit
state	string	状态可选值：active / blocked，默认值 active	active
avatarUrl	string	头像地址	https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
email	string	用户邮箱	username@example.com
signature	object	签名信息
gpgKeyId	string	gpg 签名的 key id	""
verificationStatus	string	gpg 校验状态 unverified：未校验 verified：gpg 公钥验证通过且邮箱一致 same_user_different_email：gpg 公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致 other_user：gpg 公钥验签通过，但提交者邮箱不属于 key 的用户 unverified_key：key 对应的邮箱，不在该用户的邮箱列表中 unknown_key：gpg key 不存在	verified
commentsCount	long	评论数量	0

示例

正常返回示例

JSON格式

{
  "requestId": "6177543A-8D54-5736-A93B-E0195A1512CB",
  "errorMessage": "\"\"",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "result": {
    "name": "master",
    "protected": "false",
    "commit": {
      "id": "e0297d8fb0393c833a8531e7cc8832739e3cba6d",
      "shortId": "e0297d8f",
      "title": "修改main.txt文件",
      "authorName": "阿里云云效",
      "authorEmail": "username@example.com",
      "createdAt": "2022-03-18 10:00:00",
      "message": "修改main.txt文件",
      "authoredDate": "2022-03-18 08:00:00",
      "committedDate": "2022-03-18 09:00:00",
      "committerEmail": "username@example.com",
      "committerName": "阿里云云效Committer",
      "parentIds": [
        "de02b625ba8488f92eb204bcb3773a40c1b4ddac"
      ],
      "author": {
        "id": 28056,
        "name": "codeup-test",
        "username": "testtest",
        "state": "active",
        "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
        "email": "username@example.com"
      },
      "committer": {
        "id": 5035,
        "name": "codeup-commit",
        "username": "commitcommit",
        "state": "active",
        "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
        "email": "username@example.com"
      },
      "signature": {
        "gpgKeyId": "\"\"",
        "verificationStatus": "verified"
      },
      "commentsCount": 0
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.AccessDenied	The user is not authorized to perform the operation.	用户无权限执行相关操作
403	Forbidden.UserNotInCurrentOrganization	The user is not in the organization and is not authorized to perform the operation.	当前用户不在该企业中，无权进行操作。

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

变更历史

变更时间	变更内容概要	操作
2023-07-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情