查询外部链接 - ShowIpdThirdPartyAssociated
功能介绍
需要获取IPD项目下工作项对应的外部链接列表时,可调用此接口,用户可以通过项目ID和工作项ID查询该工作项关联的所有外部链接。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v2/projects/{project_id}/issues/{issue_id}/associate-third-party
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 10~32768个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 响应状态。 取值范围: |
| message | String | 参数解释: 查询失败的原因。 取值范围: 不涉及。 |
| result | ThirdPartyAssociatedResult object | 参数解释: 查询出工作项相关的外部链接列表的响应结果。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 参数解释: 工作项关联外部链接查询结果数据集 |
| count | String | 参数解释: 工作项关联外部链接总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of ThirdPartyAssociatedDTO objects | 参数解释: 工作项关联外部链接查询结果数据集合 |
| page | PageVO object | 参数解释: 工作项关联外部链接查询结果分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| domain_id | String | 参数解释: 工作项归属项目的项目空间ID。 取值范围: 不涉及。 |
| id | String | 参数解释: 新关联外部链接时会创建一条数据,该数据的唯一标识ID,可以在查询外部链接接口以及关联外部链接接口响应体中找到。 取值范围: 不涉及。 |
| created_date | String | 参数解释: 工作项下关联外部链接的创建时间。 取值范围: 不涉及。 |
| created_by | String | 参数解释: 工作项下关联外部链接的创建人。 取值范围: 不涉及。 |
| title | String | 参数解释: 工作项下关联外部链接的名称。 取值范围: 不涉及。 |
| url | String | 参数解释: 工作项下关联外部链接的地址。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| page | String | 参数解释: 当前页。 取值范围: 不涉及 |
| size | String | 参数解释: 每页条数。 取值范围: 不涉及 |
| count | String | 参数解释: 数据总数。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
假设项目ID为fd23836651d349e7bcac6d8fb87abb03,工作项ID为1192478008741236736,查询该工作项已经关联的外部链接,示例如下:
GET https://{endpoint}/v2/projects/fd23836651d349e7bcac6d8fb87abb03/issues/1192478008741236736/associate-third-party 响应示例
状态码:200
查询工作项对应外部链接列表成功的响应。
{
"status" : "success",
"message" : null,
"result" : {
"data" : {
"result" : [ {
"domain_id" : "1174316100266926080",
"id" : "1200488524084838400",
"created_date" : "2025-11-26T17:12:48Z",
"title" : "测试11321",
"created_by" : "op_svc_projectman_ccms_52fd0607",
"url" : "https"
}, {
"domain_id" : "1174316100266926080",
"id" : "1200485886706094081",
"created_date" : "2025-11-26T17:02:19Z",
"title" : "测试beta",
"created_by" : "devcloud_devcloud_s_01",
"url" : "https"
}, {
"domain_id" : "1174316100266926080",
"id" : "1200477155000221697",
"created_date" : "2025-11-26T16:27:37Z",
"title" : "测试1",
"created_by" : "op_svc_projectman_ccms_52fd0607",
"url" : "httpsurl"
} ],
"page" : {
"page" : 1,
"size" : 200,
"count" : 3
}
},
"count" : 3
}
} 状态码:400
查询工作项对应外部链接列表失败的响应,例如:项目不存在、关联工作项不存在或已删除等。
{
"error_code" : "PM.02176410",
"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 | 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 ShowIpdThirdPartyAssociatedSolution { 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(); ShowIpdThirdPartyAssociatedRequest request = new ShowIpdThirdPartyAssociatedRequest(); request.withIssueId("{issue_id}"); request.withProjectId("{project_id}"); try { ShowIpdThirdPartyAssociatedResponse response = client.showIpdThirdPartyAssociated(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 | # 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 = ShowIpdThirdPartyAssociatedRequest() request.issue_id = "{issue_id}" request.project_id = "{project_id}" response = client.show_ipd_third_party_associated(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 | 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.ShowIpdThirdPartyAssociatedRequest{} request.IssueId = "{issue_id}" request.ProjectId = "{project_id}" response, err := client.ShowIpdThirdPartyAssociated(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询工作项对应外部链接列表成功的响应。 |
| 400 | 查询工作项对应外部链接列表失败的响应,例如:项目不存在、关联工作项不存在或已删除等。 |
错误码
请参见错误码。