查询分支提交的历史信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /api/v4/projects/{ProjectId}/repository/commits HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
AccessToken | String | Query | 否 | 146dd344827fe2444f952e931e51xxxx | 个人访问令牌。使用阿里云AK+SK或使用STS临时授权方式不需要传该字段。 |
ProjectId | Long | Path | 是 | 100 | 代码库ID |
OrganizationId | String | Query | 是 | 60811b5eed6e867404f6xxxx | 企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/ |
Page | Long | Query | 否 | 1 | 页数,最小值为1 |
PageSize | Long | Query | 否 | 20 | 每页条数,取值范围为1到100 |
Search | String | Query | 否 | xxx | 搜索关键字 |
Path | String | Query | 否 | src/main/java | 文件路径 |
RefName | String | Query | 是 | master | 分支名称、标签名称或提交版本 |
ShowSignature | Boolean | Query | 否 | false | 是否展示签名信息,默认false |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | xxxx-xxxx-xxxx-xxxx | 请求ID |
ErrorMessage | String | 代码库不存在 | 错误信息 |
Total | Long | 100 | 总条数 |
Success | Boolean | true | 是否成功 |
ErrorCode | String | SYSTEM_UNAUTHORIZED_ERROR | 错误码 |
Result | Array of Result | 响应数据 |
|
ShortId | String | b022b451 | 短ID |
AuthorName | String | xxx | 作者姓名 |
AuthorDate | String | 2020-09-03T16:49:00+08:00 | 作者提交时间 |
CreatedAt | String | 2020-09-03T16:49:00+08:00 | 创建时间 |
Message | String | 提交信息 | 提交信息 |
Title | String | 提交标题 | 标题,提交的第一行内容 |
CommitterName | String | xxx | 提交者姓名 |
AuthorEmail | String | username@example.com | 作者邮箱 |
Id | String | b022b4518194d8078c825990fd878838dafdxxxx | 提交ID |
CommitterEmail | String | username@example.com | 提交者邮箱 |
CommittedDate | String | 2020-09-03T16:49:00+08:00 | 提交者提交时间 |
ParentIds | Array of String | 2020-09-03T16:49:00+08:00 | 提交ID |
Signature | Object | 签名信息 |
|
VerificationStatus | String | unverified | 验证状态
|
GpgKeyId | String | xxx | GPG Key ID |
示例
请求示例
GET /api/v4/projects/100/repository/commits?AccessToken=146dd344827fe2444f952e931e51xxxx&OrganizationId=60811b5eed6e867404f6xxxx&Page=1&PageSize=20&Search=xxx&Path=src/main/java&RefName=master&ShowSignature=false HTTP/1.1
Host:codeup.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListRepositoryCommitsResponse>
<RequestId>xxxx-xxxx-xxxx-xxxx</RequestId>
<ErrorMessage>代码库不存在</ErrorMessage>
<Total>100</Total>
<Success>true</Success>
<ErrorCode>SYSTEM_UNAUTHORIZED_ERROR</ErrorCode>
<Result>
<ShortId>b022b451</ShortId>
<AuthorName>xxx</AuthorName>
<AuthorDate>2020-09-03T16:49:00+08:00</AuthorDate>
<CreatedAt>2020-09-03T16:49:00+08:00</CreatedAt>
<Message>提交信息</Message>
<Title>提交标题</Title>
<CommitterName>xxx</CommitterName>
<AuthorEmail>username@example.com</AuthorEmail>
<Id>b022b4518194d8078c825990fd878838dafdxxxx</Id>
<CommitterEmail>username@example.com</CommitterEmail>
<CommittedDate>2020-09-03T16:49:00+08:00</CommittedDate>
<ParentIds>2020-09-03T16:49:00+08:00</ParentIds>
<Signature>
<VerificationStatus>unverified</VerificationStatus>
<GpgKeyId>xxx</GpgKeyId>
</Signature>
</Result>
</ListRepositoryCommitsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "xxxx-xxxx-xxxx-xxxx",
"ErrorMessage" : "代码库不存在",
"Total" : 100,
"Success" : true,
"ErrorCode" : "SYSTEM_UNAUTHORIZED_ERROR",
"Result" : [ {
"ShortId" : "b022b451",
"AuthorName" : "xxx",
"AuthorDate" : "2020-09-03T16:49:00+08:00",
"CreatedAt" : "2020-09-03T16:49:00+08:00",
"Message" : "提交信息",
"Title" : "提交标题",
"CommitterName" : "xxx",
"AuthorEmail" : "username@example.com",
"Id" : "b022b4518194d8078c825990fd878838dafdxxxx",
"CommitterEmail" : "username@example.com",
"CommittedDate" : "2020-09-03T16:49:00+08:00",
"ParentIds" : [ "2020-09-03T16:49:00+08:00" ],
"Signature" : {
"VerificationStatus" : "unverified",
"GpgKeyId" : "xxx"
}
} ]
}
错误码
访问错误中心查看更多错误码。