UpdateCheckRun - 更新检查运行_云效(Apsara Devops)-阿里云帮助中心

更新check run记录信息，须当前身份与check run的写入人身份一致，才能进行更新。

调试

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

授权信息

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

请求语法

POST /api/v4/projects/check_runs/update_check_run

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	60de7a6852743a5162b5f957
accessToken	string	否	个人访问令牌。使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段	f0b1e61db5961df5975a93f9129d2513
repositoryIdentity	string	是	代码库 ID 或者全路径	2835387 或 codeup/codeup-demo
checkRunId	long	是	检查运行 ID	2
body	object	否	请求 Body
name	string	否	检查运行的名称	my-check-ci
startedAt	string	否	检查运行的开始时间说明 ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z	2023-03-15T08:00:00Z
completedAt	string	否	检查运行的完结时间说明说明 ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z	2023-03-15T08:00:00Z
externalId	string	否	外部系统的 ID 说明外部系统，指用户的检测系统；该字段由用户自行决定写入何种 ID，平台仅使用字符串类型进行存储	42
detailsUrl	string	否	三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力	xx
status	string	否	状态 queued：队列中 in_progress：运行中 completed：已完结	completed
conclusion	string	否	结论 cancelled：已取消 failure：失败 neutral：中立状态，算作成功状态 success：成功 skipped：跳过，算作成功状态 timed_out：超时	success
output	object	否	页面展示信息
title	string	否	UI 模块的标题（非 name）	Mighty Readme report
summary	string	是	检查运行的摘要信息说明支持 markdown 格式；最大字符长度为 64KB，即 65535 个字符	摘要信息内容
text	string	否	详情信息说明支持 markdown 格式；最大字符长度为 64KB，即 65535 个字符	详情信息内容
images	array<object>	否	图片信息列表说明 check run 支持在 output 的展示模块中，展示图片信息
	object	否	图片信息
alt	string	是	alt 文本信息	test-image-alt
imageUrl	string	是	图片地址，须确保能够有效访问，否则页面无法展示	xxx
caption	string	否	图片信息的简要描述	test
annotations	array<object>	否	检查注释列表说明对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过 API 将信息通过 annotation 写入到 check run 中在更新操作中，annotations 信息只会新增，所以在使用时，尽量不要重复写入
	object	否	检查注释
path	string	是	文件路径	demo/test.txt
startLine	long	是	起始行说明从 1 开始；需要用户自行确保文件行数的有效性，否则无法展示	1
endLine	long	是	结束行	2
startColumn	long	否	起始列说明当且仅当 startLine=endLine 时，该字段值有效	3
endColumn	long	否	结束列说明当且仅当 startLine=endLine 时，该字段值有效	5
annotationLevel	string	是	检查注释的等级 notice：轻微 warning：警告 failure：严重	failure
message	string	是	简要描述信息	回写检查注释的简要描述信息
title	string	否	检查注释的标题	检查注释的标题
rawDetails	string	否	详情信息，限制 64KB 以内的大小	详情信息内容

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	ASSDS-ASSASX-XSAXSA-XSAXSAXS
success	boolean	调用是否成功	true
errorCode	string	错误码	SYSTEM_UNKNOWN_ERROR
errorMessage	string	错误信息	""
result	object	返回结果
id	long	唯一标识	524836
createdAt	string	创建时间	2022-01-14T21:08:26+08:00
updatedAt	string	更新时间	2022-01-14T21:08:26+08:00
startedAt	string	开始时间	2023-03-15T08:00:00Z
completedAt	string	完结时间	2023-03-15T08:00:00Z
externalId	string	外部系统 ID	42
name	string	名称	my-check-ci
headSha	string	提交 ID	40f4ccfe019cdd4a62d4acb0c57130106fc7e1be
status	string	状态 queued：队列中 in_progress：运行中 completed：已完结	completed
conclusion	string	结论 cancelled：已取消 failure：失败 neutral：中立状态，算作成功 success：成功 skipped：跳过，算作成功状态 timed_out：超时	success
detailsUrl	string	三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力	xxx
checkSuite	object	检查套件
id	long	检查套件 ID，唯一标识	1
writer	object	写入人简要信息
id	string	用户阿里云账号 ID	xxx
type	string	写入人类型 User：用户类型	User
name	string	写入人名称	test-codeup
slug	string	别名	test-codeup
logoUrl	string	写入人头像地址	xxx
output	object	页面展示信息
title	string	UI 模块的标题（非 name）	Mighty Readme report
summary	string	检查运行的摘要信息说明支持 markdown 格式；最大字符长度为 64KB，即 65535 个字符	摘要信息内容
text	string	详情信息说明支持 markdown 格式；最大字符长度为 64KB，即 65535 个字符	详情信息内容
images	array<object>	图片信息说明 check run 支持在 output 的展示模块中，展示图片信息
	object	图片信息
alt	string	alt 文本信息	test-image-alt
imageUrl	string	图片地址，须确保能够有效访问，否则页面无法展示	xxx
caption	string	图片信息的简要描述	test
annotations	array<object>	检查注释列表说明对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过 API 将信息通过 annotation 写入到 check run 中。
	object	检查注释
id	long	检查注释 ID，唯一标识	1
path	string	文件路径	demo/test.txt
startLine	long	起始行说明从 1 开始；需要用户自行确保文件行数的有效性，否则无法展示	1
endLine	long	结束行	2
startColumn	long	起始列说明当且仅当 startLine=endLine 时，该字段值有效	3
endColumn	long	结束列说明当且仅当 startLine=endLine 时，该字段值有效	5
annotationLevel	string	检查注释的等级 notice：轻微 warning：警告 failure：严重	warning
message	string	简要描述信息	回写检查注释的简要描述信息
title	string	检查注释的标题	检查注释的标题
rawDetails	string	详情信息，限制 64KB 以内的大小	详情信息

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "success": true,
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "result": {
    "id": 524836,
    "createdAt": "2022-01-14T21:08:26+08:00\n",
    "updatedAt": "2022-01-14T21:08:26+08:00\n",
    "startedAt": "2023-03-15T08:00:00Z\n",
    "completedAt": "2023-03-15T08:00:00Z\n",
    "externalId": "42",
    "name": "my-check-ci\n",
    "headSha": "40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\n",
    "status": "completed",
    "conclusion": "success",
    "detailsUrl": "xxx",
    "checkSuite": {
      "id": 1
    },
    "writer": {
      "id": "xxx\n",
      "type": "User",
      "name": "test-codeup\n",
      "slug": "test-codeup\n",
      "logoUrl": "xxx\n"
    },
    "output": {
      "title": "Mighty Readme report\n",
      "summary": "摘要信息内容\n",
      "text": "详情信息内容",
      "images": [
        {
          "alt": "test-image-alt\n",
          "imageUrl": "xxx",
          "caption": "test\n"
        }
      ]
    },
    "annotations": [
      {
        "id": 1,
        "path": "demo/test.txt\n",
        "startLine": 1,
        "endLine": 2,
        "startColumn": 3,
        "endColumn": 5,
        "annotationLevel": "warning",
        "message": "回写检查注释的简要描述信息\n",
        "title": "检查注释的标题\n",
        "rawDetails": "详情信息\n"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史