更新时间:2026-09-01 GMT+08:00
分享

创建标签 - CreateIpdLabel

功能介绍

创建标签

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

POST /v1/ipdprojectservice/projects/{project_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

label_type

String

参数解释

标签所属工作项类型,对应工作项的type字段,枚举类型。不推荐使用此参数,建议使用category_types参数。

约束限制

不涉及。

取值范围

  • raw requirement:原始需求

  • feature:系统特性

  • requirement:研发需求

  • task:任务

  • bug:缺陷

默认取值

不涉及。

color

String

参数解释

标签颜色,作为更新参数时非必填。

约束限制

不涉及。

取值范围

可选颜色代码与对应中文描述如下:

  • #86CAFF:浅蓝色

  • #6DDEBB:青绿色

  • #A6DD82:黄绿色

  • #FAC20A:金黄色

  • #FA9841:橙色

  • #F66F6A:珊瑚红

  • #F3689A:粉红色

  • #A97AF8:淡紫色

  • #71757F:中性灰

  • #5E7CE0:宝蓝色

  • #207AB3:深蓝色

  • #169E6C:翠绿色

  • #6CA83B:草绿色

  • #B58200:棕黄色

  • #B54E04:赭石色

  • #B02121:朱红色

  • #AD215B:玫红色

  • #572DB3:深紫色

  • #4F4F4F:深灰色

  • #3C51A6:靛蓝色

默认取值

不涉及。

title

String

参数解释

标签标题。

约束限制

1~30个字符。

取值范围

不涉及。

默认取值

不涉及。

category_types

String

参数解释

工作项类型编码。

约束限制

不涉及。

取值范围

支持多种工作项类型,使用英文逗号分隔。

  • 系统设备类项目:RR、SF、IR、SR、AR、Task、Bug

  • 独立软件类项目:RR、SF、IR、US、Task、Bug

  • 云服务类项目:RR、Epic、FE、US、Task、Bug

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

返回状态。

取值范围

  • success:响应成功

  • error:响应失败

message

String

响应信息

result

LabelCreateResult object

标签详情

表4 LabelCreateResult

参数

参数类型

描述

id

String

参数解释

标签ID,可通过查询标签列表接口获取,响应消息体中的id字段的值就是标签ID。

取值范围

不涉及。

category_types

Array of strings

参数解释

标签所属工作项类型编码。

color

String

参数解释

标签颜色RGB。

取值范围

不涉及。

title

String

参数解释

标签标题。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

创建研发需求的标签

POST https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/tags

{
  "title" : "Tag-IR-05",
  "color" : "#A6DD82",
  "label_type" : "requirement",
  "category_types" : "IR,SR"
}

响应示例

状态码:200

OK

{
  "status" : "success",
  "message" : "ok",
  "result" : {
    "id" : "1250583934720716801",
    "color" : "#A6DD82",
    "title" : "Tag-RR-01",
    "category_types" : [ "IR" ]
  }
}

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

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
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateIpdLabelSolution {

    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();
        CreateIpdLabelRequest request = new CreateIpdLabelRequest();
        request.withProjectId("{project_id}");
        LabelParam body = new LabelParam();
        body.withTitle("Tag-IR-05");
        body.withColor("#A6DD82");
        body.withLabelType(LabelParam.LabelParam.fromValue("requirement"));
        request.withBody(body);
        try {
            CreateIpdLabelResponse response = client.createIpdLabel(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 = CreateIpdLabelRequest()
        request.project_id = "{project_id}"
        request.body = LabelParam(
            title="Tag-IR-05",
            color="#A6DD82",
            label_type="requirement"
        )
        response = client.create_ipd_label(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.CreateIpdLabelRequest{}
	request.ProjectId = "{project_id}"
	labelTypeLabelParam:= model.GetLabelParamLabelTypeEnum().REQUIREMENT
	request.Body = &model.LabelParam{
		Title: "Tag-IR-05",
		Color: "#A6DD82",
		LabelType: &labelTypeLabelParam,
	}
	response, err := client.CreateIpdLabel(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档