Updated on 2025-08-25 GMT+08:00

Querying the Bug Density

Function

This API is used to query bug density.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/bug-density/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

Regular expression: [A-Za-z0-9]{32}

Options:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

date_range

No

String

Definition:

Statistical period.

Constraints:

N/A

Options:

N/A

Default value:

N/A

metric_type

No

String

Definition:

Metric type.

Constraints:

Regular expression: (bug_density|issues_per_developer|on-time_completion_rate)

Options:

bug_density ()

issues_per_developer ()

on-time_completion_rate ()

Default value:

(bug_density|issues_per_developer|on-time_completion_rate)

dividend

No

dividend object

Default value:

N/A

Definition:

Numerator filter criteria.

Constraints:

N/A

divisor

No

divisor object

Definition:

Denominator filter criteria.

Constraints:

N/A

Table 4 dividend

Parameter

Mandatory

Type

Description

custom_fields

No

Array of custom_fields objects

Definition:

Custom type filter criteria.

Constraints:

N/A

Table 5 custom_fields

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Custom field name.

Constraints:

The value is a string of 1 to 40 characters, which can contain letters, digits, spaces, and specific special characters.

Options:

N/A

Default value:

N/A

options

No

String

Definition:

Custom field values.

Constraints:

Use commas to separated values.

Options:

The value contains 1 to 2,500 characters.

Default value:

N/A

Table 6 divisor

Parameter

Mandatory

Type

Description

custom_fields

No

Array of custom_fields objects

Definition:

Custom type filter criteria.

Constraints:

N/A

Table 7 custom_fields

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Custom field name.

Constraints:

Use commas to separated values.

Options:

N/A

Default value:

N/A

options

No

String

Definition:

Custom field values.

Constraints:

Use commas to separated values.

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

dividend_value

String

Definition:

Numerator.

Options:

N/A

divisor_value

String

Definition:

Denominator.

Options:

N/A

metric_name

String

Definition:

Metric name.

Options:

N/A

metric_value

String

Definition:

Metric value.

Options:

N/A

project_id

String

Definition:

Project ID.

Options:

N/A

project_name

String

Definition:

Project name.

Options:

N/A

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Post https://{endpoint}/v2/eace9c0a00574de6878ab580daa9a317/bug-density/query

{
  "date_range" : "1590940800000,1593446400000",
  "dividend" : {
    "custom_fields" : [ {
      "name" : "Custom field name.",
      "options" : "Custom field value"
    } ]
  },
  "divisor" : {
    "custom_fields" : [ {
      "name" : "Custom field name.",
      "options" : "Custom field value"
    } ]
  },
  "metric_type" : "bug_density"
}

Example Responses

Status code: 200

OK

{
  "dividend_value" : 15,
  "divisor_value" : 20,
  "metric_name" : "completion_rate|bug_density|bugs_per_developer",
  "metric_value" : 0.8945,
  "project_id" : "eace9c0a00574de6878ab580daa9a317",
  "project_name" : "demo"
}

SDK Sample Code

The SDK sample code is as follows.

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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.*;

import java.util.List;
import java.util.ArrayList;

public class ShowBugDensityV2Solution {

    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();
        ShowBugDensityV2Request request = new ShowBugDensityV2Request();
        request.withProjectId("{project_id}");
        MetricRequestV2 body = new MetricRequestV2();
        List<MetricRequestV2DividendCustomFields> listDividendCustomFields = new ArrayList<>();
        listDividendCustomFields.add(
            new MetricRequestV2DividendCustomFields()
                .withName("Custom field name.")
                .withOptions("Custom field value")
        );
        MetricRequestV2Dividend dividendbody = new MetricRequestV2Dividend();
        dividendbody.withCustomFields(listDividendCustomFields);
        body.withDivisor("{\"custom_fields\":[{\"name\":\"Custom field name.\",\"options\":\"Custom field value\"}]}");
        body.withDividend(dividendbody);
        body.withMetricType("bug_density");
        body.withDateRange("1590940800000,1593446400000");
        request.withBody(body);
        try {
            ShowBugDensityV2Response response = client.showBugDensityV2(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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# 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 = ShowBugDensityV2Request()
        request.project_id = "{project_id}"
        listCustomFieldsDividend = [
            MetricRequestV2DividendCustomFields(
                name="Custom field name.",
                options="Custom field value"
            )
        ]
        dividendbody = MetricRequestV2Dividend(
            custom_fields=listCustomFieldsDividend
        )
        request.body = MetricRequestV2(
            divisor="{\"custom_fields\":[{\"name\":\"Custom field name.\",\"options\":\"Custom field value\"}]}",
            dividend=dividendbody,
            metric_type="bug_density",
            date_range="1590940800000,1593446400000"
        )
        response = client.show_bug_density_v2(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
50
51
52
53
54
55
56
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.ShowBugDensityV2Request{}
	request.ProjectId = "{project_id}"
	nameCustomFields:= "Custom field name."
	optionsCustomFields:= "Custom field value"
	var listCustomFieldsDividend = []model.MetricRequestV2DividendCustomFields{
        {
            Name: &nameCustomFields,
            Options: &optionsCustomFields,
        },
    }
	dividendbody := &model.MetricRequestV2Dividend{
		CustomFields: &listCustomFieldsDividend,
	}
	var divisorMetricRequestV2 interface{} = "{\"custom_fields\":[{\"name\":\"Custom field name.\",\"options\":\"Custom field value\"}]}"
	metricTypeMetricRequestV2:= "bug_density"
	dateRangeMetricRequestV2:= "1590940800000,1593446400000"
	request.Body = &model.MetricRequestV2{
		Divisor: &divisorMetricRequestV2,
		Dividend: dividendbody,
		MetricType: &metricTypeMetricRequestV2,
		DateRange: &dateRangeMetricRequestV2,
	}
	response, err := client.ShowBugDensityV2(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.