工作项关联的提交信息 - ListItemCommits
功能介绍
工作项关联的提交信息
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartsrepo:repository:getRepository |
Read |
- |
- |
- |
- |
URI
GET /v4/projects/{project_id}/items/{item_id}/commits
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
|
item_id |
是 |
String |
参数解释: 工作项Id。 约束限制: 不涉及 取值范围: 字符串长度不少于1,不超过128。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Total |
String |
当前请求的结果总条数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of ItemCommitDto objects |
工作项关联的提交信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 关联Id。 取值范围: 不涉及 取值范围: 0~2147483647 |
|
title |
String |
参数解释: 合并请求标题。 取值范围: 不涉及。 |
|
result |
Integer |
参数解释: 仓库状态。 取值范围: 取值范围: 0~10 |
|
type |
String |
参数解释: 关联提交类型。 取值范围: |
|
message |
String |
参数解释: 关联失败的失败原因。 取值范围: 不涉及。 |
|
item_id |
String |
参数解释: 工作项Id。 取值范围: 不涉及。 |
|
repository_id |
String |
参数解释: 仓库Id。 取值范围: 不涉及。 |
|
branch_name |
String |
参数解释: 分支名。 取值范围: 不涉及。 |
|
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
|
commit_id |
String |
参数解释: 提交Id。 取值范围: 不涉及。 |
|
commit_short_id |
String |
参数解释: 提交短Id。 取值范围: 不涉及。 |
|
commit_msg |
String |
参数解释: 提交信息。 取值范围: 不涉及。 |
|
commit_url |
String |
参数解释: 提交访问地址。 取值范围: 不涉及。 |
|
iam_id |
String |
参数解释: iamId。 取值范围: 不涉及。 |
|
create_at |
String |
参数解释: 创建时间。 取值范围: 不涉及。 |
|
update_at |
String |
参数解释: 更新时间。 取值范围: 不涉及。 |
|
item_url |
String |
参数解释: 工作项访问地址。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/projects/936c6b54d29446958a7e668d04eceaac/items/9261401/commits
响应示例
状态码:200
OK
[ {
"id" : 2111625445,
"title" : null,
"result" : 3,
"type" : "commit",
"message" : null,
"iam_id" : "c369c68f1ff84679b5a8ed904d8bff1c",
"repository_id" : "2111984490",
"branch_name" : "dev1",
"user_name" : "CodeHub_beta_dev",
"commit_id" : "9052a9accb4b2838daefeda790bda8c871ee3551",
"commit_short_id" : "9052a9ac",
"commit_msg" : "更新 README.md fix #9261401 dev123",
"commit_url" : "https://example.com/codehub/2111984490/9052a9accb4b2838daefeda790bda8c871ee3551/commitdetail",
"item_id" : "9261401",
"create_at" : "2025-09-17T07:58:59.000+00:00",
"update_at" : "null,",
"item_url" : "https://example.com/projectman/scrum/936c6b54d29446958a7e668d04eceaac/task/detail/9261401"
} ]
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码:403
Bad Request
{
"error_code" : "DEV-23-50804",
"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.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; public class ListItemCommitsSolution { 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); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("<YOUR REGION>")) .build(); ListItemCommitsRequest request = new ListItemCommitsRequest(); request.withItemId("{item_id}"); request.withProjectId("{project_id}"); try { ListItemCommitsResponse response = client.listItemCommits(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 huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.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 = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListItemCommitsRequest() request.item_id = "{item_id}" request.project_id = "{project_id}" response = client.list_item_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" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/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 := codeartsrepo.NewCodeArtsRepoClient( codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListItemCommitsRequest{} request.ItemId = "{item_id}" request.ProjectId = "{project_id}" response, err := client.ListItemCommits(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Bad Request |
错误码
请参见错误码。