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

修改外部链接 - UpdateIpdThirdParty

功能介绍

需要修改IPD项目下的工作项对应的外部链接时,可调用此接口,用户可以通过项目ID和工作项ID确定工作项,传入需要修改的外部链接唯一标识ID,此ID可以通过查询外部链接接口获得,以及修改后的名称和地址,修改该工作项的某条外部链接的名称和地址。

调用方法

请参见如何调用API

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:workitem:update

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /v2/projects/{project_id}/issues/{issue_id}/associate-third-party

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

32个字符的UUID。

默认取值

不涉及。

issue_id

String

参数解释

工作项唯一ID。可以通过查询工作项列表或者查询树状工作项获取,响应消息体中的ID字段的值就是工作项ID。

约束限制

不涉及。

取值范围

18~19个字符的数字字符串。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

10~32768个字符。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

title

String

参数解释

工作项下关联外部链接的名称。

约束限制

不涉及。

取值范围

1~256个字符。

默认取值

不涉及。

url

String

参数解释

工作项下关联外部链接的地址。

约束限制

不涉及。

取值范围

以https开头。例如:https://www.example.com。

默认取值

不涉及。

id

String

参数解释

新关联外部链接时会创建一条数据,该数据的唯一标识ID,可以在查询外部链接接口以及关联外部链接接口响应体中找到。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释

响应状态。

取值范围

  • success:修改或删除外部链接成功。

  • error:修改或删除外部链接失败。

message

String

参数解释

修改或删除工作项下外部链接失败的原因。

取值范围

不涉及。

result

Array of strings

参数解释

修改或删除工作项下外部链接的响应结果。

取值范围

更新的字段或者删除的ID。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

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

取值范围

不涉及。

请求示例

假设项目ID为fd23836651d349e7bcac6d8fb87abb03,工作项ID为1192478008741236736,将该工作项下唯一标识为1200477155000221697(通过查询外部链接接口获得)的外部链接的名称修改为测试1,地址修改为https://www.goddodu.com,示例如下:

PUT https://{endpoint}/v2/projects/fd23836651d349e7bcac6d8fb87abb03/issues/1192478008741236736/associate-third-party

{
  "id" : "1200477155000221697",
  "title" : "测试1",
  "url" : "https://www.goddodu.com"
}

响应示例

状态码:200

更新工作项下外部链接成功的响应结果。

{
  "status" : "success",
  "message" : null,
  "result" : {
    "fail" : [ ],
    "success" : [ [ "modified_by", "title", "modified_date", "url" ] ]
  }
}

状态码:400

更新工作项下外部链接失败的响应结果,例如:工作项不存在、数据不存在、url非https://开头等。

{
  "error_code" : "PM.02171202",
  "error_msg" : "关联工作项类型参数错误"
}

SDK代码示例

SDK代码示例如下。

Java

假设项目ID为fd23836651d349e7bcac6d8fb87abb03,工作项ID为1192478008741236736,将该工作项下唯一标识为1200477155000221697(通过查询外部链接接口获得)的外部链接的名称修改为测试1,地址修改为https://www.goddodu.com,示例如下:

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

    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();
        UpdateIpdThirdPartyRequest request = new UpdateIpdThirdPartyRequest();
        request.withProjectId("{project_id}");
        request.withIssueId("{issue_id}");
        UpdateThirdPartyAssociateVO body = new UpdateThirdPartyAssociateVO();
        body.withId("1200477155000221697");
        body.withUrl("https://www.goddodu.com");
        body.withTitle("测试1");
        request.withBody(body);
        try {
            UpdateIpdThirdPartyResponse response = client.updateIpdThirdParty(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

假设项目ID为fd23836651d349e7bcac6d8fb87abb03,工作项ID为1192478008741236736,将该工作项下唯一标识为1200477155000221697(通过查询外部链接接口获得)的外部链接的名称修改为测试1,地址修改为https://www.goddodu.com,示例如下:

 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 = UpdateIpdThirdPartyRequest()
        request.project_id = "{project_id}"
        request.issue_id = "{issue_id}"
        request.body = UpdateThirdPartyAssociateVO(
            id="1200477155000221697",
            url="https://www.goddodu.com",
            title="测试1"
        )
        response = client.update_ipd_third_party(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

假设项目ID为fd23836651d349e7bcac6d8fb87abb03,工作项ID为1192478008741236736,将该工作项下唯一标识为1200477155000221697(通过查询外部链接接口获得)的外部链接的名称修改为测试1,地址修改为https://www.goddodu.com,示例如下:

 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.UpdateIpdThirdPartyRequest{}
	request.ProjectId = "{project_id}"
	request.IssueId = "{issue_id}"
	request.Body = &model.UpdateThirdPartyAssociateVo{
		Id: "1200477155000221697",
		Url: "https://www.goddodu.com",
		Title: "测试1",
	}
	response, err := client.UpdateIpdThirdParty(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

更新工作项下外部链接成功的响应结果。

400

更新工作项下外部链接失败的响应结果,例如:工作项不存在、数据不存在、url非https://开头等。

错误码

请参见错误码

相关文档