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

创建变更

功能介绍

创建变更。

调用方法

请参见如何调用API。

URI

POST /v2/{cloudProjectId}/change-request/create

表1 路径参数

参数

是否必选

参数类型

描述

cloudProjectId

是

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

component_id

是

String

微服务ID

title

是

String

变更标题

type

否

String

变更类型，默认为code

workitem_ids

是

Array of strings

工作项ID

repos

是

Array of repos objects

变更代码仓信息
表3 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

发布后是否删除特性分支

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

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/change-request/create

{
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "title" : "aaaaa",
  "type" : "code",
  "workitem_ids" : [ "2332711" ],
  "repos" : [ {
    "http_url" : "https://example.com/test00001/maven.git",
    "git_url" : "git@example.com:test00001/maven.git",
    "feature_branch" : "aaaaaa",
    "main_branch" : "master",
    "delete_branch_after_released" : false,
    "repo_id" : "804934"
  } ]
}

响应示例

状态码：200

ok

{
  "id" : "495d94a305d4456f9a8a1efaaf2d34e0",
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "status" : "developing",
  "title" : "aaaa",
  "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" : [ "2332711" ],
  "release_time" : null,
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "p_test5",
  "create_time" : "1719217063",
  "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
  "updater_name" : "p_test5",
  "update_time" : "1719217063"
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题： 变更管理