查询分支提交历史信息

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /api/v4/projects/[ProjectId]/repository/commits HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
OrganizationId String Query 60811b5eed6e867404f6xxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如

https://devops.aliyun.com/organization/

ProjectId Long Path 100

代码库ID

RefName String Query master

分支名称、标签名称或提交版本。

AccessToken String Query 146dd344827fe2444f952e931e51xxxx

个人访问令牌。

使用阿里云AK+SK或使用STS临时授权方式不需要传该字段

Page Long Query 1

页数,最小值为1

PageSize Long Query 20

每页条数,范围1, 100

Search String Query xxx

搜索关键字

Path String Query /src/main/java

文件路径

ShowSignature Boolean Query false

是否展示签名。默认false

返回数据

名称 类型 示例值 描述
ErrorCode String SYSTEM_UNAUTHORIZED_ERROR

错误码

ErrorMessage String 代码库不存在

错误信息

RequestId String xxxx-xxxx-xxxx-xxxx

请求ID

Result Array of Result

响应数据

AuthorDate String 2020-09-03T16:49:00+08:00

作者提交时间

AuthorEmail String xxxx@xxxx.com

作者邮箱

AuthorName String xxx

作者姓名

CommittedDate String 2020-09-03T16:49:00+08:00

提交者提交时间

CommitterEmail String xxxx@xxxx.com

提交者邮箱

CommitterName String xxx

提交者姓名

CreatedAt String 2020-09-03T16:49:00+08:00

创建时间

Id String b022b4518194d8078c825990fd878838dafdxxxx

commit SHA

Message String feat: xxxxxx

提交信息

ParentIds List ["c26d27d4912f2e1679f31a312112acfxxxxxxxxx"]

父提交 ID

ShortId String b022b451

短 ID

Signature Struct

签名信息

GpgKeyId String xxx

GPG key ID

VerificationStatus String unverified

验证状态

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

标题,提交的第一行内容

Success Boolean true

请求结果

Total Long 100

提交总数

示例

请求示例

GET /api/v4/projects/[ProjectId]/repository/commits HTTP/1.1
公共请求头
```json
{
    "OrganizationId": "60811b5eed6e867404f6xxxx",
    "ProjectId": "100",
    "RefName": "master"
}

正常返回示例

XML格式

<RequestId>xxxx-xxxx-xxxx-xxxx</RequestId>
<Total>100</Total>
<ErrorCode>SYSTEM_UNAUTHORIZED_ERROR</ErrorCode>
<ErrorMessage>代码库不存在</ErrorMessage>
<Success>true</Success>
<Result>
    <Message>feat: xxxxxx</Message>
    <CommitterEmail>xxxx@xxxx.com</CommitterEmail>
    <CommittedDate>2020-09-03T16:49:00+08:00</CommittedDate>
    <AuthorName>xxx</AuthorName>
    <AuthorDate>2020-09-03T16:49:00+08:00</AuthorDate>
    <CreatedAt>2020-09-03T16:49:00+08:00</CreatedAt>
    <Title>feat: xxxxxx</Title>
    <ShortId>b022b451</ShortId>
    <Id>b022b4518194d8078c825990fd878838dafdxxxx</Id>
    <AuthorEmail>xxxx@xxxx.com</AuthorEmail>
    <CommitterName>xxx</CommitterName>
    <ParentIds>["c26d27d4912f2e1679f31a312112acfxxxxxxxxx"]</ParentIds>
    <Signature>
        <VerificationStatus>unverified</VerificationStatus>
        <GpgKeyId>xxx</GpgKeyId>
    </Signature>
</Result>

JSON格式

{"RequestId":"xxxx-xxxx-xxxx-xxxx","Total":"100","ErrorCode":"SYSTEM_UNAUTHORIZED_ERROR","ErrorMessage":"代码库不存在","Success":"true","Result":[{"Message":"feat: xxxxxx","CommitterEmail":"xxxx@xxxx.com","CommittedDate":"2020-09-03T16:49:00+08:00","AuthorName":"xxx","AuthorDate":"2020-09-03T16:49:00+08:00","CreatedAt":"2020-09-03T16:49:00+08:00","Title":"feat: xxxxxx","ShortId":"b022b451","Id":"b022b4518194d8078c825990fd878838dafdxxxx","AuthorEmail":"xxxx@xxxx.com","CommitterName":"xxx","ParentIds":"[\"c26d27d4912f2e1679f31a312112acfxxxxxxxxx\"]","Signature":{"VerificationStatus":"unverified","GpgKeyId":"xxx"}}]}

错误码

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