文档

CreateCommitStatus - 添加提交状态记录

更新时间:

给指定的Commit添加一条提交状态记录。

接口说明

根据 Commit SHA 和 Context 作为组合条件,限制单库的提交状态记录不超过 1000 条,否则会报错。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v4/projects/repository/commit_statuses/create_commit_status

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdentitystring

代码库 ID 或者全路径

2080972
shastring

仅支持提交 ID,即 Commit SHA

e0c1a1299a2656bfc155650bbd2df5e628fa1f4c
bodyobject

请求 Body

statestring

写入状态,且仅能填入以下四个字符串,否则会返回错误。

  • error:异常
  • failure:失败
  • pending:运行中
  • success:成功
success
descriptionstring

提交状态的简要描述,且不能超过 3000 个字符

提交状态描述内容
targetUrlstring

用户自行写入的跳转链接,代码平台仅提供跳转的 UI,一般可设置为三方系统的链接

xxx
contextstring

用于区分不同系统写入的字符串标识,会以标题的作用在相应的页面 UI 处进行展示,默认为 default,长度不超过 50,且英文大小写不敏感

说明 该参数在设置卡点和合并请求联动中非常重要,若非测试调试,切勿随意设置。
default

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

020F71F3-F063-5B8B-8978-2B01833216BB
successboolean

调用是否成功

true
errorCodestring

错误码

SYSTEM_UNKNOWN_ERROR
errorMessagestring

错误信息

""
resultobject

返回结果

idlong

ID(无业务实际意义)

30815
shastring

提交 ID,即 Commit SHA

c0ca103441b9fa7f369be8d24a6f20db44dfddf7
contextstring

用于区分不同系统写入的字符串标识,会以标题的作用在相应的页面 UI 处进行展示,默认为 default,长度不超过 50,且英文大小写不敏感

default
statestring

写入状态

  • error:异常
  • failure:失败
  • pending:运行中
  • success:成功
success
targetUrlstring

用户自行写入的跳转链接,代码平台仅提供跳转的 UI,一般可设置为三方系统的链接

xxx
descriptionstring

提交状态的简要描述,且不能超过 3000 个字符

提交状态描述内容
creatorobject

提交状态的写入人简要信息

aliyunPklong

阿里云账号 ID,若 type=Bot 时,则为空

204485087002425236
loginstring

若 type=User,则为用户名;若 type=Bot,则为应用名

codeup
avatarUrlstring

头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
typestring

写入人类型

  • User:普通用户类型
  • Bot:应用类型
User

示例

正常返回示例

JSON格式

{
  "requestId": "020F71F3-F063-5B8B-8978-2B01833216BB",
  "success": true,
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "result": {
    "id": 30815,
    "sha": "c0ca103441b9fa7f369be8d24a6f20db44dfddf7",
    "context": "default",
    "state": "success",
    "targetUrl": "xxx",
    "description": "提交状态描述内容",
    "creator": {
      "aliyunPk": 204485087002425250,
      "login": "codeup",
      "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
      "type": "User"
    }
  }
}

错误码

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

  • 本页导读 (0)