查询提交状态列表_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI查询提交状态列表，支持分页。

适用版本

企业标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
产品
资源
所需权限
代码管理
提交状态
只读

请求语法

GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/commits/{sha}/statuses

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	组织 ID。	5ebbc0228123212b59xxxxx
repositoryId	string	path	是	代码库 ID 或者 URL-Encoder 编码的全路径。	2835387 或 codeup/codeup-demo
sha	string	path	是	提交 ID，即 Commit SHA。
page	integer	query	否	页码，默认从1开始，一般不要超过150页。	1
perPage	integer	query	否	每页大小，默认20，取值范围【1，100】。	20

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/commits/{sha}/statuses?page=<page>&perPage=<perPage>' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
author	object	写入人信息。
avatarUrl	string	用户头像地址。	https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
id	string	用户 ID。	30815
name	string	用户名称。	codeup
type	string	写入人类型：User - 用户；Bot - 应用（暂无）。	Bot
username	string	用户登录名。	codeup-test
context	string	用于区分不同系统的字符串标识，会以标题的作用在相应的页面进行展示，长度不超过50；使用时，请认真设置值。	test-commit-status-context
createdAt	string	写入时间。	2024-09-05
description	string	简要描述信息，且不超过3000个字符。	描述信息的具体内容
id	integer	主键 ID，无业务实义。	19285
sha	string	提交 ID，即 Commit SHA。	61cc69557962d29f737a91730b3e86f497f083a3
state	string	写入状态：error - 异常；failure - 失败；pending - 运行中；success - 成功。	success
targetUrl	string	用户写入的外部链接，代码平台提供跳转的 UI，一般可设置为三方系统的链接。	xxx
updatedAt	string	更新时间。	2024-09-10

返回示例

[
    {
        "author": {
            "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
            "id": "19285",
            "name": "codeup",
            "type": "Bot",
            "username": "codeup-test"
        },
        "context": "test-commit-status-context",
        "createdAt": "2024-09-05",
        "description": "描述信息的具体内容\n",
        "id": 19285,
        "sha": "61cc69557962d29f737a91730b3e86f497f083a3",
        "state": "success",
        "targetUrl": "xxx",
        "updatedAt": "2024-09-10"
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。	2
x-page	当前页。	1
x-per-page	每页大小。	20
x-prev-page	前一页。	0
x-request-id	请求 ID。	ASSDS-ASSASX-XSAXSA-XSAXSAXS
x-total	总数。	10
x-total-pages	总分页数。	1

错误码

访问错误码中心查看 API 相关错误码。

产品	资源	所需权限
代码管理	提交状态	只读