查询提交状态列表,支持分页。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v4/projects/repository/commit_statuses/list_commit_statuses HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| organizationId |
string |
是 |
企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 |
5ebbc0228123212b59xxxxx |
| accessToken |
string |
否 |
个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 |
f0b1e61db5961df5975a93f9129d2513 |
| repositoryIdentity |
string |
是 |
代码库 ID 或者全路径 |
2835387 或 codeup/codeup-demo |
| sha |
string |
是 |
仅支持提交 ID,即 Commit SHA |
61cc69557962d29f737a91730b3e86f497f083a3 |
| page |
integer |
否 |
页码,默认值为 1,从第 1 页开始 |
1 |
| pageSize |
integer |
否 |
每页大小,默认值为 20,取值范围【1,100】 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID |
ASSDS-ASSASX-XSAXSA-XSAXSAXS |
| success |
boolean |
请求是否成功。
|
true |
| errorCode |
string |
错误码 |
SYSTEM_UNKNOWN_ERROR |
| errorMessage |
string |
错误信息 |
"" |
| total |
integer |
总记录数 |
28 |
| result |
array<object> |
返回结果列表 |
|
|
array<object> |
返回结果 |
||
| id |
integer |
ID(无业务实际意义 |
19285 |
| sha |
string |
仅支持提交 ID,即 Commit SHA |
61cc69557962d29f737a91730b3e86f497f083a3 |
| context |
string |
用于区分不同系统写入的字符串标识,会以标题的作用在相应的页面 UI 处进行展示,默认为 default,长度不超过 50,且英文大小写不敏感 |
test-commit-status-context |
| state |
string |
写入状态
|
success |
| targetUrl |
string |
用户自行写入的跳转链接,代码平台仅提供跳转的 UI,一般可设置为三方系统的链接 |
xxx |
| description |
string |
提交状态的简要描述,且不能超过 3000 个字符 |
描述信息的具体内容 |
| creator |
object |
提交状态的写入人简要信息 |
|
| aliyunPk |
string |
阿里云账号 ID,若 type=Bot 时,则为空 |
235671547828975455 |
| login |
string |
若 type=User,则为用户名;若 type=Bot,则为应用名 |
codeup |
| avatarUrl |
string |
头像地址 |
https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100 |
| type |
string |
写入人类型
|
User |
示例
正常返回示例
JSON格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"success": true,
"errorCode": "SYSTEM_UNKNOWN_ERROR",
"errorMessage": "\"\"",
"total": 28,
"result": [
{
"id": 19285,
"sha": "61cc69557962d29f737a91730b3e86f497f083a3",
"context": "test-commit-status-context",
"state": "success",
"targetUrl": "xxx",
"description": "描述信息的具体内容\n",
"creator": {
"aliyunPk": "235671547828975455",
"login": "codeup",
"avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
"type": "User"
}
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。