GetBranchInfo - 查询分支信息

查询代码库分支的信息。

调试

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

授权信息

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

请求语法

GET /repository/{repositoryId}/branches/detail

请求参数

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

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

5fbe3118672533690be72b12
accessTokenstring

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

f0b1e61db5961df5975a93f9129d2513
repositoryIdlong

代码库 ID

2334743
branchNamestring

分支名称

master

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

6177543A-8D54-5736-A93B-E0195A1512CB
errorMessagestring

错误信息

""
errorCodestring

错误码

Openapi.RequestError
successboolean

请求是否成功

true
resultobject

返回结果

namestring

分支名称

master
protectedstring

是否是保护分支

false
commitobject

分支最近一次提交信息

idstring

提交 ID

e0297d8fb0393c833a8531e7cc8832739e3cba6d
shortIdstring

简短的提交 ID

e0297d8f
titlestring

提交标题,提交的第一行内容

修改main.txt文件
authorNamestring

作者姓名

阿里云云效
authorEmailstring

作者邮箱

username@example.com
createdAtstring

创建时间

2022-03-18 10:00:00
messagestring

提交内容

修改main.txt文件
authoredDatestring

作者提交时间

2022-03-18 08:00:00
committedDatestring

提交人的提交时间

2022-03-18 09:00:00
committerEmailstring

提交人的邮箱

username@example.com
committerNamestring

提交人的姓名

阿里云云效Committer
parentIdsarray

父提交 ID 列表

string

父提交 ID

de02b625ba8488f92eb204bcb3773a40c1b4ddac
authorobject

作者信息

idlong

Codeup 的用户 ID

28056
namestring

作者名称

codeup-test
usernamestring

用户昵称

testtest
statestring

状态 可选值:active / blocked,默认值 active

active
avatarUrlstring

头像地址

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

用户邮箱

username@example.com
committerobject

提交人信息

idlong

Codeup 的用户 ID

5035
namestring

提交人的姓名

codeup-commit
usernamestring

用户昵称

commitcommit
statestring

状态 可选值:active / blocked,默认值 active

active
avatarUrlstring

头像地址

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

用户邮箱

username@example.com
signatureobject

签名信息

gpgKeyIdstring

gpg 签名的 key id

""
verificationStatusstring

gpg 校验状态

  • unverified:未校验
  • verified:gpg 公钥验证通过且邮箱一致
  • same_user_different_email:gpg 公钥验签通过,提交者邮箱属于当前用户,但与证书邮箱不一致
  • other_user:gpg 公钥验签通过,但提交者邮箱不属于 key 的用户
  • unverified_key:key 对应的邮箱,不在该用户的邮箱列表中
  • unknown_key:gpg key 不存在
verified
commentsCountlong

评论数量

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错误码错误信息描述
403Forbidden.AccessDeniedThe user is not authorized to perform the operation.用户无权限执行相关操作
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。

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

变更历史

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