创建提交状态_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 创建或写入提交状态，更新操作也使用该接口。

适用版本

企业标准版

服务接入点与授权信息

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

请求语法

POST 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 编码的全路径。	2080972
sha	string	path	是	提交 ID，即 Commit SHA。	e0c1a1299a2656bfc155650bbd2df5e628fa1f4c
-	object	body	否
context	string	body	否	用于区分不同系统写入的字符串标识，会以标题的作用在 UI 页面展示，默认为 default，长度不超过50；该参数在卡点设置和合并请求联动中扮演重要的角色，若非测试情况，切勿随意设置。	default
description	string	body	否	描述信息。	提交状态描述内容
state	string	body	否	写入状态，且仅能填入以下四个字符串：error - 异常；failure - 失败；pending - 运行中；success - 成功。	success
targetUrl	string	body	否	用户写入的跳转链接，代码平台仅提供跳转的 UI，一般可设置为三方系统首页的链接。	xxx

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/commits/{sha}/statuses' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "context": "default",
        "description": "提交状态描述内容",
        "state": "success",
        "targetUrl": "xxx"
    }'

返回参数

参数	类型	描述	示例值
-	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；使用时，请认真设置值。	default
createdAt	string	写入时间。	2024-09-05
description	string	简要描述信息，且不超过3000个字符。	提交状态描述内容
id	integer	主键 ID，无业务实义。	30815
sha	string	提交 ID，即 Commit SHA。	c0ca103441b9fa7f369be8d24a6f20db44dfddf7
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": "30815",
        "name": "codeup",
        "type": "Bot",
        "username": "codeup-test"
    },
    "context": "default",
    "createdAt": "2024-09-05",
    "description": "提交状态描述内容",
    "id": 30815,
    "sha": "c0ca103441b9fa7f369be8d24a6f20db44dfddf7",
    "state": "success",
    "targetUrl": "xxx",
    "updatedAt": "2024-09-10"
}

错误码

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

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