# 更新标签 - UpdateIpdLabel #### 功能介绍 更新标签，支持更新标题和颜色。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:tag:update | Write | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI PUT /v1/ipdprojectservice/projects/{project_id}/tags/{label_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目32位ID，项目唯一标识。通过[查询IPD项目列表](https://support.huaweicloud.com/api-projectman/ShowIpdProjectList.html)获取，响应消息体中的**id**字段的值就是项目ID。 **约束限制**： 不涉及。 **取值范围**： 32个字符，由英文字母和数字组成。 **默认取值**： 不涉及。 | | label_id | 是 | String | **参数解释**： 标签ID，标签唯一标识。 可以通过[查询标签列表](https://support.huaweicloud.com/api-projectman/ListIpdLabels.html)接口获取，响应消息体中的**id**字段的值就是标签ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表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 | [LabelUpdateResult] object | 标签更新结果 | 表4LabelUpdateResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category_types | Array of strings | **参数解释**： 标签所属工作项类型编码。 | | color | String | **参数解释**： 标签颜色RGB。 **取值范围**： 不涉及。 | | title | String | **参数解释**： 标签标题。 **取值范围**： 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述，对error_code的补充解释。 **取值范围**： 不涉及。 | #### 请求示例 更新标签标题 ``` PUT https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/tags/1030868827803529217 { "title" : "Tag-RR-01", "color" : "#A6DD82", "category_types" : "IR" } ``` #### 响应示例 **状态码：200** OK ``` { "status" : "success", "message" : "ok", "result" : { "color" : "#A6DD82", "title" : "Tag-RR-01", "category_types" : [ "IR" ] } } ``` **状态码：400** 请求失败的响应。例如无操作权限、项目不存在。 ``` { "error_code" : "PM.02174103", "error_msg" : "无操作权限" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 更新标签标题 ``` 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 UpdateIpdLabelSolution { 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("")) .build(); UpdateIpdLabelRequest request = new UpdateIpdLabelRequest(); request.withLabelId("{label_id}"); request.withProjectId("{project_id}"); LabelParam body = new LabelParam(); body.withTitle("Tag-RR-01"); body.withColor("#A6DD82"); request.withBody(body); try { UpdateIpdLabelResponse response = client.updateIpdLabel(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 更新标签标题 ``` # 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("")) \ .build() try: request = UpdateIpdLabelRequest() request.label_id = "{label_id}" request.project_id = "{project_id}" request.body = LabelParam( title="Tag-RR-01", color="#A6DD82" ) response = client.update_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 更新标签标题 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.UpdateIpdLabelRequest{} request.LabelId = "{label_id}" request.ProjectId = "{project_id}" request.Body = &model.LabelParam{ Title: "Tag-RR-01", Color: "#A6DD82", } response, err := client.UpdateIpdLabel(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ProjectMan/sdk?api=UpdateIpdLabel)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 请求失败的响应。例如无操作权限、项目不存在。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。