文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 变更管理/ 查询流水线上的变更
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流水线上的变更

功能介绍

查询流水线上的变更

调用方法

请参见如何调用API。

URI

POST /v2/{cloudProjectId}/pipeline/change-requests/search

表1 路径参数

参数

是否必选

参数类型

描述

cloudProjectId

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

component_id

是

String

参数解释：

微服务ID。可以通过查询微服务列表接口获取，其中data.id即为微服务ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

limit

是

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

offset

是

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

statuses

是

Array of strings

参数解释：

变更状态。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

title

否

String

参数解释：

变更名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

变更记录总数。

取值范围：

不涉及。

data

Array of ChangeRequestVO objects

参数解释：

变更记录详情。

取值范围：

不涉及。
表4 ChangeRequestVO

参数

参数类型

描述

id

String

参数解释：

变更ID。

取值范围：

32位字符，由数字和字母组成。

component_id

String

参数解释：

微服务ID。

取值范围：

32位字符，由数字和字母组成。

status

String

参数解释：

状态。

取值范围：

不涉及。

title

String

参数解释：

标题。

取值范围：

不涉及。

repos

Array of repos objects

参数解释：

变更代码仓信息。

取值范围：

不涉及。

workitem_ids

Array of strings

参数解释：

工作项ID。

取值范围：

不涉及。

release_time

String

参数解释：

发布时间。

取值范围：

不涉及。

creator_id

String

参数解释：

创建人ID。

取值范围：

32位字符，由数字和字母组成。

creator_name

String

参数解释：

创建人名称。

取值范围：

不涉及。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。

updater_id

String

参数解释：

更新人ID。

取值范围：

32位字符，由数字和字母组成。

updater_name

String

参数解释：

更新人名称。

取值范围：

不涉及。

update_time

String

参数解释：

更新时间。

取值范围：

不涉及。
表5 repos

参数

参数类型

描述

repo_id

String

参数解释：

Repo代码仓ID。

取值范围：

不涉及。

http_url

String

参数解释：

代码仓HTTP地址。

取值范围：

不涉及。

git_url

String

参数解释：

代码仓GIT地址。

取值范围：

不涉及。

feature_branch

String

参数解释：

特性分支。

取值范围：

不涉及。

main_branch

String

参数解释：

默认分支。

取值范围：

不涉及。

delete_branch_after_released

Boolean

参数解释：

发布后是否删除特性分支。

取值范围：

  • true：发布后删除特性分支。

  • false：发布后不删除特性分支。

请求示例

POST https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/pipeline/change-requests/search

{
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "limit" : 10,
  "offset" : 0,
  "statuses" : [ "releasing", "to_be_released" ],
  "title" : ""
}

响应示例

状态码：200

OK

{
  "total" : 1,
  "data" : [ {
    "id" : "adebc0cd4e9f44dfb92a6f5ad5106c2b",
    "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
    "status" : "developing",
    "title" : "11",
    "repos" : [ {
      "repo_id" : "804934",
      "http_url" : "https://example.com/test00001/maven.git",
      "git_url" : "git@example.com:test00001/maven.git",
      "feature_branch" : "aaa",
      "main_branch" : "master",
      "delete_branch_after_released" : false
    } ],
    "workitem_ids" : null,
    "release_time" : null,
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator_name" : "test5",
    "create_time" : "1719231005",
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "updater_name" : "test5",
    "update_time" : "1719231005"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 变更管理

相关文档