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

查询变更列表

功能介绍

查询变更列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

cloudProjectId

是

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

statuses

否

Array of strings

变更状态["developing","releasing","to_be_released","released","revoked"]

creator_ids

否

String

创建人ID

title

否

String

变更名称

component_id

是

String

微服务ID

offset

是

Integer

偏移

limit

是

Integer

页大小

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

记录数

data

Array of ChangeRequestVO objects

变更记录
表4 ChangeRequestVO

参数

参数类型

描述

id

String

变更ID

component_id

String

微服务ID

status

String

状态

title

String

标题

repos

Array of repos objects

变更代码仓信息

workitem_ids

Array of strings

工作项ID

release_time

String

发布时间

creator_id

String

创建人ID

creator_name

String

创建人名称

create_time

String

创建时间

updater_id

String

更新人ID

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

发布后是否删除特性分支

请求示例

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

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

响应示例

状态码： 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

错误码

请参见错误码。

父主题： 变更管理

相关文档