文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目计划管理/ 更新发布/迭代状态 - ChangePlanStatus
更新时间:2026-10-13 GMT+08:00

更新发布/迭代状态 - ChangePlanStatus

功能介绍

更新发布/迭代状态

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:plan:update

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /v1/planservice/projects/{project_id}/plans/{plan_id}/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制:

32个字符,由英文字母和数字组成。

取值范围:

不涉及。

默认取值:

不涉及。

plan_id

是

String

参数解释:

发布/迭代唯一ID。可以通过发布/迭代计划列表查询接口获取,响应消息体中的id字段的值就是发布/迭代ID。

约束限制:

长度为18-19位的数字字符串。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

operate

是

String

参数解释:

操作类型。

约束限制:

不涉及。

取值范围:

  • start:开始发布/迭代计划

  • complete:完成发布/迭代计划

  • reset:将计划状态设置为"未开始"

  • restart:重新开始发布/迭代计划

  • move:将工作项移动到其他迭代

默认取值:

不涉及。

move_to_sprint_id

否

String

参数解释:

将工作项移动到指定迭代ID。operate参数值为complete时,需要将未完成的工作项移动到其他迭代。

约束限制:

operate参数值为complete时需填写。空字符串表示将工作项移动到"待规划"。

取值范围:

长度为18~19个字符的数字字符串。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

返回状态。

取值范围:

  • success:操作成功

  • error:操作失败

message

String

参数解释:

提示信息。

取值范围:

不涉及。

result

StatusChangeResult object

参数解释:

状态变更结果数据,包含不可完成的工作项信息。

表4 StatusChangeResult

参数

参数类型

描述

cannot_finish_ar

Array of WorkItemVO objects

参数解释:

不可完成的AR工作项列表,当完成发布/迭代时,未完成的AR工作项会列出在此。

表5 WorkItemVO

参数

参数类型

描述

id

String

参数解释:

工作项唯一ID。

取值范围:

不涉及。

title

String

参数解释:

工作项标题。

取值范围:

不涉及。

number

String

参数解释:

工作项编号。

取值范围:

不涉及。

category

String

参数解释:

工作项分类。

取值范围:

不涉及。

status

StatusVO object

参数解释:

工作项状态信息。

assignee

UserVO object

参数解释:

工作项责任人信息。

baseline

String

参数解释:

工作项基线状态。

取值范围:

  • baselined:已基线

  • unbaseline:未基线

  • "":未基线

change_status

String

参数解释:

工作项变更状态。

取值范围:

  • cannot_finish:不可完成

表6 StatusVO

参数

参数类型

描述

id

String

参数解释:

状态ID。

取值范围:

不涉及。

name

String

参数解释:

状态名称。

取值范围:

不涉及。

表7 UserVO

参数

参数类型

描述

id

String

参数解释:

用户ID,32位uuid。

取值范围:

不涉及。

name

String

参数解释:

用户名称。

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误描述信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

PUT https://{endpoint}/v1/planservice/projects/526cefde62004de2b62b5e8dd2c2b3af/plans/123456789012345678/status

{
  "operate" : "move",
  "move_to_sprint_id" : "12345678901234567890123456789012"
}

响应示例

状态码:200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "cannot_finish_ar" : [ {
      "id" : "956239067176935424",
      "title" : "AR工作项1",
      "number" : "AR1234567890",
      "category" : "AR",
      "status" : {
        "id" : "1",
        "name" : "进行中"
      },
      "assignee" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "用户A"
      },
      "baseline" : "unbaseline",
      "change_status" : "cannot_finish"
    } ]
  }
}

状态码:400

{
  "error_msg" : "参数错误,例如operate参数不在合法范围内",
  "error_code" : "PM.02175011"
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ChangePlanStatusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ChangePlanStatusRequest request = new ChangePlanStatusRequest();
        request.withPlanId("{plan_id}");
        request.withProjectId("{project_id}");
        CompleteSprintVO body = new CompleteSprintVO();
        body.withMoveToSprintId("12345678901234567890123456789012");
        body.withOperate("move");
        request.withBody(body);
        try {
            ChangePlanStatusResponse response = client.changePlanStatus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ChangePlanStatusRequest()
        request.plan_id = "{plan_id}"
        request.project_id = "{project_id}"
        request.body = CompleteSprintVO(
            move_to_sprint_id="12345678901234567890123456789012",
            operate="move"
        )
        response = client.change_plan_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.ChangePlanStatusRequest{}
	request.PlanId = "{plan_id}"
	request.ProjectId = "{project_id}"
	moveToSprintIdCompleteSprintVo:= "12345678901234567890123456789012"
	request.Body = &model.CompleteSprintVo{
		MoveToSprintId: &moveToSprintIdCompleteSprintVo,
		Operate: "move",
	}
	response, err := client.ChangePlanStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新发布/迭代状态成功

400

Bad Request

错误码

请参见错误码。