更新时间:2025-08-25 GMT+08:00

获取Scrum项目概览

功能介绍

获取Scrum项目概览

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围:

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

bug_statistics

Array of BugStatisticResponseV4 objects

参数解释:

bug统计列表

demand_statistics

Array of DemandStatisticResponseV4 objects

参数解释:

按模块统计列表

issue_completion_rates

Array of IssueCompletionRateResponseV4 objects

参数解释:

按工作项类型统计列表

project_id

String

参数解释:

项目id

取值范围:

长度:32

表4 BugStatisticResponseV4

参数

参数类型

描述

critical_num

Integer

参数解释:

重要程度为关键的缺陷数

取值范围:

不涉及

defect_index

Double

参数解释:

DI值,不同重要程度的缺陷对应不同的分值

取值范围:

不涉及

module

String

参数解释:

模块

取值范围:

不涉及

normal_num

Integer

参数解释:

重要程度为一般的缺陷数

取值范围:

不涉及

serious_num

Integer

参数解释:

重要程度为严重的缺陷数

取值范围:

不涉及

tip_num

Integer

参数解释:

重要程度为提示的缺陷数

取值范围:

不涉及

total

Integer

参数解释:

总数

取值范围:

不涉及

表5 DemandStatisticResponseV4

参数

参数类型

描述

closed_num

Integer

参数解释:

按模块统计已关闭数量

取值范围:

不涉及

module

String

参数解释:

模块信息

取值范围:

不涉及

new_num

Integer

参数解释:

按模块统计新建的数量

取值范围:

不涉及

process_num

Integer

参数解释:

按模块统计进行中数量

取值范围:

不涉及

rejected_num

Integer

参数解释:

按模块统计已拒绝数量

取值范围:

不涉及

solved_num

Integer

参数解释:

按模块统计已解决数量

取值范围:

不涉及

test_num

Integer

参数解释:

按模块统计测试中数量

取值范围:

不涉及

total

Integer

参数解释:

按模块统计总数

取值范围:

不涉及

表6 IssueCompletionRateResponseV4

参数

参数类型

描述

issue_status

IssueStatusResponseV4 object

参数解释:

工作项状态维度的统计信息

tracker_id

Integer

参数解释:

工作项类型

取值范围:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

表7 IssueStatusResponseV4

参数

参数类型

描述

closed_num

Integer

参数解释:

当前项目中工作项已关闭数量

取值范围:

不涉及

new_num

Integer

参数解释:

当前项目中工作项新建的数量

取值范围:

不涉及

process_num

Integer

参数解释:

当前项目中工作项开发中的数量

取值范围:

不涉及

rejected_num

Integer

参数解释:

当前项目中工作项已拒绝数量

取值范围:

不涉及

solved_num

Integer

参数解释:

当前项目中工作项已解决数量

取值范围:

不涉及

test_num

Integer

参数解释:

当前项目中工作项测试中的数量

取值范围:

不涉及

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary

响应示例

状态码:200

OK

{
  "bug_statistics" : [ {
    "critical_num" : 0,
    "defect_index" : 1,
    "module" : "统计分数",
    "normal_num" : 1,
    "serious_num" : 0,
    "tip_num" : 0,
    "total" : 1
  } ],
  "demand_statistics" : [ {
    "closed_num" : 1,
    "module" : "计费",
    "new_num" : 1,
    "process_num" : 1,
    "rejected_num" : 1,
    "solved_num" : 1,
    "test_num" : 1,
    "total" : 1
  } ],
  "issue_completion_rates" : [ {
    "issue_status" : {
      "closed_num" : 1,
      "new_num" : 1,
      "process_num" : 1,
      "rejected_num" : 1,
      "solved_num" : 1,
      "test_num" : 1
    },
    "tracker_id" : 0
  } ],
  "project_id" : "526cefde62004de2b62b5e8dd2c2b3af"
}

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

    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();
        ShowProjectSummaryV4Request request = new ShowProjectSummaryV4Request();
        request.withProjectId("{project_id}");
        try {
            ShowProjectSummaryV4Response response = client.showProjectSummaryV4(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
# 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 = ShowProjectSummaryV4Request()
        request.project_id = "{project_id}"
        response = client.show_project_summary_v4(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
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.ShowProjectSummaryV4Request{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowProjectSummaryV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码