调用ListSearchCommit搜索代码提交数据_云效(Apsara Devops)-阿里云帮助中心

根据筛选条件搜索提交的相关数据。

调试

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

授权信息

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

请求语法

POST /search/commit

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	60d54f3daccf2bbd6659f3ad
body	object	是	请求 Body
keyword	string	是	搜索关键字	test
page	integer	否	页码默认值为 1，从第 1 页开始	1
pageSize	integer	否	每页大小默认值为 20，取值范围【1,100】	10
order	string	否	排序字段，默认为 default default：默认排序，即综合排序 created_at：创建时间 updated_at：更新时间 star：收藏数 like：点赞数 comment：评论数 reply：回复数	default
sort	string	否	排序方式，默认为 desc desc：降序 asc：升序	desc
scope	string	否	搜索范围，默认为 all all：全局范围，公开库以及有权限的 private 库 mine：只作为库或组成员，并且有读权限	all
repoPath	object	否	代码仓库查询条件
value	string	否	代码库的全路径，例如：organization/group/repo 说明若有多个代码库全路径，使用英文逗号","隔开	orgId/test-group/spring-boot-demo
operatorType	string	否	查询条件类型 equal：等于 unequal：不等于 and：与 or：或 not：非	equal
matchType	string	否	查询匹配类型 term：精确匹配 regex：正则匹配 phrase：短语匹配，默认方式 wildcard：模糊匹配	term

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	F7B85D1B-D1C2-140F-A039-341859F130B9
errorMessage	string	错误信息	""
errorCode	string	错误码	SYSTEM_UNKNOWN_ERROR
success	boolean	调用是否成功	true
total	long	总记录数	10
result	array<object>	返回列表
	object	返回的提交数据
docId	string	文档 ID	60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb
highlightTextMap	object	高亮文本信息
commitId	string	提交 ID	df1b701cb0f3f7ca92320d49d31995821f2d045c
title	string	提交标题，提交的第一行内容	提交标题
commitMessage	string	提交的具体内容	提交内容
organizationId	string	企业 ID	60de7a6852743a5162b5f957
source	object	ES 返回的源信息
commitId	string	提交 ID	a748f5ecb17a93900d4808944bfcc96dc158ee2d
title	string	提交标题，提交的第一行内容	提交标题
commitMessage	string	提交信息	提交信息
authorTime	string	提交时间	2022-11-11 11:11:11
repoPath	string	代码库完整路径（含完整组路径）	codeup/test-repo
organizationId	string	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	61133b011bd96aa110f1b500
author	object	提交者
name	string	提交者的姓名	云效
email	string	提交者的邮箱	username@example.com

示例

正常返回示例

JSON格式

{
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9",
  "errorMessage": "\"\"",
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "success": true,
  "total": 10,
  "result": [
    {
      "docId": "\t\n60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb",
      "highlightTextMap": {
        "commitId": "df1b701cb0f3f7ca92320d49d31995821f2d045c",
        "title": "提交标题",
        "commitMessage": "提交内容",
        "organizationId": "60de7a6852743a5162b5f957"
      },
      "source": {
        "commitId": "a748f5ecb17a93900d4808944bfcc96dc158ee2d",
        "title": "提交标题",
        "commitMessage": "提交信息",
        "authorTime": "2022-11-11 11:11:11",
        "repoPath": "codeup/test-repo",
        "organizationId": "61133b011bd96aa110f1b500",
        "author": {
          "name": "云效",
          "email": "username@example.com"
        }
      }
    }
  ]
}

错误码

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

变更历史

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

暂无变更历史