文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 分支迭代操作管理/ 修改迭代

更新时间：2025-07-24 GMT+08:00

在线调试

CLI示例

查看PDF

修改迭代

功能介绍

修改迭代

调用方法

请参见如何调用API。

URI

PUT /v4/iterators/{iterator_uri}

表1 路径参数
参数	是否必选	参数类型	描述
iterator_uri	是	String	迭代URI

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	参数解释名称约束限制不涉及取值范围不涉及默认取值不涉及
number	否	String	参数解释开发分支名称约束限制不涉及取值范围不涉及默认取值不涉及
owner	否	String	参数解释处理者ID 约束限制不涉及取值范围不涉及默认取值不涉及
version	否	String	参数解释待测版本约束限制不涉及取值范围不涉及默认取值不涉及
description	否	String	参数解释描述约束限制不涉及取值范围不涉及默认取值不涉及
iterations	否	Array of strings	参数解释关联迭代约束限制不涉及取值范围不涉及默认取值不涉及
is_master	否	String	参数解释是否为Master分支约束限制不涉及取值范围不涉及默认取值不涉及
pbi_id	否	String	参数解释 PBI ID 约束限制不涉及取值范围不涉及默认取值不涉及
pbi_name	否	String	参数解释 PBI信息约束限制不涉及取值范围不涉及默认取值不涉及
plan_start_date	否	String	参数解释开始时间约束限制不涉及取值范围不涉及默认取值不涉及
plan_start_timestamp	否	Long	参数解释开始时间戳约束限制不涉及取值范围不涉及默认取值不涉及
plan_end_date	否	String	参数解释结束时间约束限制不涉及取值范围不涉及默认取值不涉及
plan_end_timestamp	否	Long	参数解释结束时间戳约束限制不涉及取值范围不涉及默认取值不涉及
asyn_git	否	String	参数解释是否同步git库约束限制不涉及取值范围不涉及默认取值不涉及
project_uuid	是	String	参数解释项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制不涉及取值范围项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字默认取值不涉及
project_name	否	String	参数解释项目名称约束限制不涉及取值范围（云龙场景，传入微服务名）默认取值不涉及
current_stage	否	String	参数解释当前所处阶段约束限制不涉及取值范围不涉及默认取值不涉及
service_types	否	Array of strings	参数解释测试类型约束限制不涉及取值范围不涉及默认取值不涉及
issue_list	否	Array of WorkItemInfo objects	参数解释关联需求约束限制不涉及取值范围不涉及默认取值不涉及
risk_rating	否	Integer	参数解释风险等级约束限制不涉及取值范围不涉及默认取值不涉及
risk_des	否	String	参数解释风险描述约束限制不涉及取值范围不涉及默认取值不涉及
is_update_risk	否	String	参数解释编辑风险信息标记约束限制不涉及取值范围不涉及默认取值不涉及
pi_id	否	String	参数解释 pi的id 约束限制层级关系：pi -> 迭代 -> 需求取值范围不涉及默认取值不涉及

表3 WorkItemInfo
参数	是否必选	参数类型	描述
work_item_id	是	String	参数解释工作项编号约束限制不涉及取值范围不涉及默认取值不涉及
has_child	是	Boolean	参数解释是否有子需求约束限制不涉及取值范围不涉及默认取值 true:是 false:否
is_open	是	Boolean	参数解释是否展开约束限制不涉及取值范围不涉及默认取值 true:是 false:否
child_list	否	Array of WorkItemInfo objects	参数解释子需求约束限制不涉及取值范围不涉及默认取值不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	参数解释本次请求的处理状态取值范围 success\|error
result	ResultValueTestVersionVo object	参数解释版本资源信息取值范围不涉及
error	ApiError object	参数解释错误信息取值范围不涉及
request_id	String	参数解释请求的唯一id 取值范围由接口调用方传入，建议使用UUID保证请求的唯一性
server_address	String	参数解释本次请求的受理的服务地址取值范围不涉及

表5 ResultValueTestVersionVo
参数	参数类型	描述
total	Integer	参数解释符合条件的所有记录数取值范围起始记录数大于实际总条数时，值为0，分页请求才有此值
value	TestVersionVo object	参数解释版本资源信息取值范围不涉及
reason	String	参数解释业务失败的提示内容取值范围不涉及
page_size	Integer	参数解释分页大小取值范围不涉及
page_no	Integer	参数解释分页编号取值范围不涉及
has_more	Boolean	参数解释是否有更多取值范围 true:是 false:否

表6 TestVersionVo
参数	参数类型	描述
uri	String	参数解释: 资源URI 取值范围: 11-34位长度的字母、数字组成的字符串
type	String	参数解释: 资源类型取值返回: TestVersion
author	String	参数解释: 创建人取值范围: 不涉及
name	String	参数解释: 名称取值范围: 不涉及
rank	Integer	参数解释: 级别取值范围: 1\|2\|3\|4
version	String	参数解释: 待测版本取值范围: 不涉及
owner	String	参数解释: 处理者ID 取值范围: 不涉及
creator	String	参数解释: 创建人ID 取值范围: 不涉及
iterations	String	参数解释: 关联迭代取值范围: 不涉及
description	String	参数解释: 描述取值范围: 不涉及
region	String	参数解释: 区域取值范围: 不涉及
last_modifier	String	参数解释: 最后修改人取值范围: 不涉及
last_modified	String	参数解释: 最后修改时间取值范围: 不涉及
last_modified_timestamp	Long	参数解释: 修改时间时间戳取值范围: 不涉及
last_change_time	String	参数解释: 最后变更时间取值范围: 不涉及
version_uri	String	参数解释: 版本URI 取值范围: 11-34位字母、数字组成的字符串
origin_uri	String	参数解释: 源资源URI 取值范围: 11-34位字母、数字组成的字符串
parent_uri	String	参数解释: 父资源URI 取值范围: 不涉及
parent_path	String	参数解释: 父资源路径取值范围: 不涉及
creation_version_uri	String	参数解释: 创建版本URI 取值范围: 11-34位字母、数字组成的字符串
creation_date	String	参数解释: 创建时间取值范围: 不涉及
creation_date_timestamp	Long	参数解释: 创建时间时间戳取值范围: 不涉及
author_name	String	参数解释: 创建人名称取值范围: 不涉及
comment	String	参数解释: 备注取值范围: 不涉及
number	String	参数解释: 编号取值范围: 不涉及
is_master	Integer	参数解释: 是否为Master分支取值范围: 0\|1
is_iterator	Integer	参数解释: 是否为迭代取值范围: 0\|1
plan_start_date	String	参数解释: 开始时间取值范围: 不涉及
plan_end_date	String	参数解释: 结束时间取值范围: 不涉及
service_id	String	参数解释: 微服务ID 取值范围: 不涉及
service_name	String	参数解释: 微服务名取值范围: 不涉及
pbi_id	String	参数解释: PBI ID 取值范围: 不涉及
pbi_name	String	参数解释: PBI信息取值范围: 不涉及
plan_id	String	参数解释: 计划ID 取值范围: 11-34位字母和数字组成的字符串
metric_pbi_ids	String	参数解释: 度量PBI ID 取值范围: 不涉及
metric_pbi_id_names	String	参数解释: 度量PBI名称取值范围: 不涉及
last_syn_date	String	参数解释: 最后同步时间取值范围: 不涉及
is_closed	String	参数解释: 版本是否关闭取值范围: 不涉及
asyn_git	String	参数解释: 是否同步git库取值范围: 不涉及
schema_no	Integer	参数解释: schema编号取值范围: 1-10
finish_date	String	参数解释: 迭代实际完成时间取值范围: 不涉及
owner_name	String	参数解释: 处理者名称取值范围: 不涉及
creator_name	String	参数解释: 创建人名称取值范围: 不涉及
current_stage	String	参数解释: 当前所处阶段取值范围: create\|strategy\|design\|execute\|report
service_types	String	参数解释: 服务类型取值范围: 不涉及
risk_rating	Integer	参数解释: 风险等级取值范围: 0\|1\|2\|3\|4\|5
risk_des	String	参数解释: 风险描述取值范围: 最大长度500位字符
project_uuid	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 取值范围: 32位字母和数字组成的字符串
domain_id	String	参数解释: 租户ID 取值范围: 11-34位字母和数字组成的字符串
pi_id	String	参数解释: pi的id 取值范围: 不涉及

表7 ApiError
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

put https://{endpoint}/v4/iterators/2dopbu6aaf

{
  "name" : "迭代1",
  "project_uuid" : "f3087a82b44744c29a1bd69ab6ada154",
  "project_name" : "新建项目1"
}

响应示例

状态码：200

修改迭代返回体

{
  "status" : "success",
  "result" : {
    "value" : {
      "uri" : "v92s10cmov8ek1jd",
      "creator" : "st112323",
      "is_master" : "false"
    }
  }
}

状态码

状态码	描述
200	修改迭代返回体
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 分支迭代操作管理

上一篇：查询迭代计划详情，包含统计信息

下一篇：删除迭代

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

修改迭代

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？