文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目计划管理/ 新建计划 - CreatePlans
更新时间：2026-10-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建计划 - CreatePlans

功能介绍

在项目下新建计划（里程碑、发布、迭代），支持创建子迭代。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartsreq:plan:create

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

POST /v1/planservice/projects/{project_id}/plans

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

长度为10-32768的字符串。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

title

是

String

参数解释：

计划标题。

约束限制：

不涉及。

取值范围：

1~256个字符。

默认取值：

不涉及。

category

是

String

参数解释：

计划分类，枚举类型。

约束限制：

不涉及。

取值范围：

  • PI：发布

  • Iteration：迭代

  • PlanMilestone：里程碑

默认取值：

不涉及。

description

否

String

参数解释：

计划描述信息。

约束限制：

不涉及。

取值范围：

0~1000个字符。

默认取值：

不涉及。

plan_start_date

是

String

参数解释：

计划开始时间，格式为yyyy-MM-dd，如2024-01-01。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

plan_end_date

是

String

参数解释：

计划完成时间，格式为yyyy-MM-dd，如2024-01-01。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

parent_id

否

String

参数解释：

父计划ID，当category为Iteration时必填，用于指定所属的发布计划。

约束限制：

category为Iteration时必填。

取值范围：

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

默认取值：

不涉及。

workload

否

String

参数解释：

预估工作量，用于标识计划所需的人力投入，单位人/天。

约束限制：

不涉及。

取值范围：

0~11个字符。

默认取值：

不涉及。

owner

否

String

参数解释：

责任人ID，标识计划的负责人。

约束限制：

不涉及。

取值范围：

长度为32个字符。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

返回状态。

取值范围：

  • success：操作成功

  • error：操作失败

message

String

参数解释：

提示信息。

取值范围：

不涉及。

result

PlanResponseResult object

参数解释：

计划详情数据，包含发布/迭代的完整信息。
表5 PlanResponseResult

参数

参数类型

描述

id

String

参数解释：

发布、迭代、里程碑的ID

取值范围：

不涉及

title

String

参数解释：

标题

取值范围：

不涉及

category

String

参数解释：

分类，枚举类型

取值范围：

  • PI：发布

  • Iteration：迭代

  • PlanMilestone：里程碑

description

String

参数解释：

描述

取值范围：

不涉及

state

String

参数解释：

作废标识，枚举类型。

取值范围：

  • 正在工作：可正常操作的发布。

  • 作废：软删除后的发布。

  • 删除：彻底删除后的发布。

status

String

参数解释：

发布/迭代的状态，枚举类型。

取值范围：

  • planned：发布/计划未开始

  • going：发布/计划进行中

  • ended：发布/计划已结束

children

Array of PlanResponseResult objects

参数解释：

子项目迭代信息

created_by

String

参数解释：

创建人ID

取值范围：

不涉及

modified_by

String

参数解释：

最近更新人ID。

取值范围：

不涉及

plan_start_date

Long

参数解释：

计划开始时间，unix时间戳，单位：毫秒。

取值范围：

不涉及

plan_end_date

Long

参数解释：

计划完成时间，unix时间戳，单位：毫秒。

取值范围：

不涉及

created_date

Long

参数解释：

创建时间，unix时间戳，单位：毫秒

取值范围：

不涉及

parent_id

String

参数解释：

父计划ID，当计划类型为迭代(Iteration)时，用于指定所属的发布计划。

取值范围：

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

baseline

String

参数解释：

基线状态，枚举类型，标识计划是否已纳入基线管理。

取值范围：

  • baselined：已基线

  • unbaseline：未基线

  • ""：未基线

workload

String

参数解释：

预估工作量，用于标识计划所需的人力或时间投入，单位人/天。

取值范围：

最大长度11个字符。

owner

String

参数解释：

责任人ID，标识计划的负责人。

取值范围：

长度为32位的字符串。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述信息。

取值范围：

不涉及。

请求示例

  • 新建发布

    POST https://{endpoint}/v1/planservice/projects/2a0d6799fe0d48b29ab8710be556d461/plans

{
  "title" : "plan_0731_1",
  "category" : "PI",
  "plan_end_date" : "2025-01-20",
  "plan_start_date" : "2025-02-01"
}

  • 新建迭代

    POST https://{endpoint}/v1/planservice/projects/2a0d6799fe0d48b29ab8710be556d461/plans

{
  "title" : "iteration_0731_1",
  "category" : "Iteration",
  "plan_end_date" : "2025-01-20",
  "plan_start_date" : "2025-02-01",
  "parent_id" : "1088833093706829825"
}

响应示例

状态码：200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "id" : "123e4567e89b12d3a456426614174000",
    "title" : "项目里程碑1",
    "category" : "PlanMilestone",
    "description" : "这是项目的一个重要里程碑",
    "state" : "正在工作",
    "status" : "planned",
    "children" : [ {
      "id" : "123e4567e89b12d3a456426614174000",
      "title" : "迭代1",
      "category" : "Iteration",
      "description" : "迭代1的描述",
      "state" : "正在工作",
      "status" : "planned",
      "children" : [ ],
      "created_by" : "user1",
      "modified_by" : "user1",
      "plan_start_date" : 1633072800000,
      "plan_end_date" : 1635751200000,
      "created_date" : 1633072800000,
      "parent_id" : "123e4567e89b12d3a456426614174000",
      "baseline" : "unbaseline",
      "workload" : "10人天",
      "owner" : "user2"
    } ],
    "created_by" : "admin",
    "modified_by" : "admin",
    "plan_start_date" : 1630466400000,
    "plan_end_date" : 1633072800000,
    "created_date" : 1630466400000,
    "parent_id" : null,
    "baseline" : "unbaseline",
    "workload" : "20人天",
    "owner" : "user1"
  }
}

状态码：400

{
  "error_msg" : "Invalid project_id or other parameters",
  "error_code" : "AS.0001"
}

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
52
    		 
    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 CreatePlansSolution {

    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();
        CreatePlansRequest request = new CreatePlansRequest();
        request.withProjectId("{project_id}");
        PlanCreateParam body = new PlanCreateParam();
        body.withPlanEndDate("2025-01-20");
        body.withPlanStartDate("2025-02-01");
        body.withCategory("PI");
        body.withTitle("plan_0731_1");
        request.withBody(body);
        try {
            CreatePlansResponse response = client.createPlans(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());
        }
    }
}

  • 新建迭代

     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
    		 
    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 CreatePlansSolution {

    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();
        CreatePlansRequest request = new CreatePlansRequest();
        request.withProjectId("{project_id}");
        PlanCreateParam body = new PlanCreateParam();
        body.withParentId("1088833093706829825");
        body.withPlanEndDate("2025-01-20");
        body.withPlanStartDate("2025-02-01");
        body.withCategory("Iteration");
        body.withTitle("iteration_0731_1");
        request.withBody(body);
        try {
            CreatePlansResponse response = client.createPlans(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
37
    		 
    # 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 = CreatePlansRequest()
        request.project_id = "{project_id}"
        request.body = PlanCreateParam(
            plan_end_date="2025-01-20",
            plan_start_date="2025-02-01",
            category="PI",
            title="plan_0731_1"
        )
        response = client.create_plans(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 新建迭代

     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
    		 
    # 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 = CreatePlansRequest()
        request.project_id = "{project_id}"
        request.body = PlanCreateParam(
            parent_id="1088833093706829825",
            plan_end_date="2025-01-20",
            plan_start_date="2025-02-01",
            category="Iteration",
            title="iteration_0731_1"
        )
        response = client.create_plans(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.CreatePlansRequest{}
	request.ProjectId = "{project_id}"
	request.Body = &model.PlanCreateParam{
		PlanEndDate: "2025-01-20",
		PlanStartDate: "2025-02-01",
		Category: "PI",
		Title: "plan_0731_1",
	}
	response, err := client.CreatePlans(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 新建迭代

     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
55
56
    		 
    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.CreatePlansRequest{}
	request.ProjectId = "{project_id}"
	parentIdPlanCreateParam:= "1088833093706829825"
	request.Body = &model.PlanCreateParam{
		ParentId: &parentIdPlanCreateParam,
		PlanEndDate: "2025-01-20",
		PlanStartDate: "2025-02-01",
		Category: "Iteration",
		Title: "iteration_0731_1",
	}
	response, err := client.CreatePlans(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

新建计划成功

400

错误信息

错误码

请参见错误码。

父主题： IPD项目计划管理