文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询当前工作项已经关联的代码提交记录 / 分支创建记录
更新时间:2025-08-18 GMT+08:00
分享

查询当前工作项已经关联的代码提交记录 / 分支创建记录

功能介绍

查询当前工作项已经关联的代码提交记录 / 分支创建记录

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/issues/{issue_id}/associated-commits

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及。

默认取值

不涉及。

issue_id

Integer

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:

查询类型。

约束限制:

正则表达式:"commit|branch"。

取值范围:

commit(提交记录)

branch(分支记录)

默认取值:

不涉及。

limit

Integer

参数解释:

条数,每页显示查询的数量。

约束限制:

不涉及。

取值范围:

最小值:1,最大值:1000。

默认取值:

10

offset

Integer

参数解释:

分页索引,偏移量,offset是limit的整数倍数。

约束限制:

从0开始。

取值范围:

最小值:0,最大值:10000。

默认取值:

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

commits

Array of CommitRecordDetail objects

参数解释:

提交记录列表。

total

Integer

参数解释:

总数。

取值范围:

不涉及。

表5 CommitRecordDetail

参数

参数类型

描述

branch_name

String

参数解释:

分支名称。

取值范围:

不涉及。

commit_id

String

参数解释:

commit id。在Git中,每次提交都会生成一个唯一的标识符,称为Commit ID。这个标识符通常是一个40位的SHA-1哈希值,用于唯一标识每一次提交。

取值范围:

不涉及。

commit_msg

String

参数解释:

commit 信息。每次提交时,开发者需要提供一个描述信息,称为Commit Msg。这个信息用于说明本次提交的具体改动内容,帮助其他开发者理解此次提交的目的和内容。

取值范围:

不涉及。

commit_short_id

String

参数解释:

commit short id。Commit Short ID是Commit ID的一个简短版本,通常为7位字符长度。它用于简化引用特定提交的操作,同时保持足够的唯一性。

取值范围:

不涉及。

commit_url

String

参数解释:

commit URL。Commit URL是指指向特定提交的URL链接。通过这个链接,可以直接访问到该提交的详细信息页面,包括提交的作者、时间、改动内容等。

取值范围:

不涉及。

create_date

String

参数解释:

创建时间。

取值范围:

不涉及。

repository_id

String

参数解释:

仓库ID。在Git中通常指的是用于唯一识别一个仓库的标识符。

取值范围:

不涉及。

type

String

参数解释:

查询的类型。

取值范围:

不涉及。

update_date

String

参数解释:

更新时间。

取值范围:

不涉及。

user

SimpleUser object

参数解释:

用户信息。

表6 SimpleUser

参数

参数类型

描述

nick_name

String

参数解释:

用户昵称,可通过获取指定项目的成员用户列表接口获取指定项目的成员用户列表中nick_name字段

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

user_id

String

参数解释:

用户uuid,可通过获取指定项目的成员用户列表接口获取指定项目的成员用户列表中user_id字段

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

user_name

String

参数解释:

账号名,可通过获取指定项目的成员用户列表接口获取指定项目的成员用户列表中user_name字段

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

user_num_id

Integer

参数解释:

用户数字id,可通过获取指定项目的成员用户列表接口获取指定项目的成员用户列表中user_num_id字段

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/projects/a360371833bf4c558f796fd707b44daf/issues/122344/associated-commits?type=commit&limit=1&offset=10

响应示例

状态码:200

查询当前工作项已经关联的代码提交记录 / 分支创建记录的返回信息。

{
  "commits" : [ {
    "repository_id" : "1865706",
    "branch_name" : "master",
    "commit_id" : "f608b02311d90f311c41711fdf67003c31305b89",
    "commit_short_id" : "f608b023",
    "commit_msg" : "demo",
    "commit_url" : "https://xxx.xxx/xxxx/commit/791877f7d0e0b2032bc5e38425c1245e804e8741?ref=master",
    "user" : {
      "user_num_id" : 4091,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_name" : "demo_user_name_xiongzhitest001",
      "nick_name" : "bear"
    },
    "type" : "branch",
    "create_date" : "2021-11-18 19:47:34",
    "update_date" : "2021-11-18 19:47:34"
  } ],
  "total" : "success"
}

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

    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();
        ListIssueAssociatedCommitsRequest request = new ListIssueAssociatedCommitsRequest();
        request.withProjectId("{project_id}");
        request.withIssueId({issue_id});
        try {
            ListIssueAssociatedCommitsResponse response = client.listIssueAssociatedCommits(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 = ListIssueAssociatedCommitsRequest()
        request.project_id = "{project_id}"
        request.issue_id = {issue_id}
        response = client.list_issue_associated_commits(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListIssueAssociatedCommitsRequest{}
	request.ProjectId = "{project_id}"
	request.IssueId = int32({issue_id})
	response, err := client.ListIssueAssociatedCommits(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

查询当前工作项已经关联的代码提交记录 / 分支创建记录的返回信息。

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档