查询需求按时完成率
功能介绍
查询需求按时完成率
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/completion-rate/query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
date_range |
否 |
String |
参数解释: 统计周期。 约束限制: 正则表达式:([0-9]{1,15},[0-9]{1,15})。 取值范围: 不涉及。 默认取值: 不涉及。 |
metric_type |
否 |
String |
参数解释: 指标类型。 约束限制: 正则表达式:(bug_density|issues_per_developer|on-time_completion_rate)。 取值范围: bug_density,issues_per_developer,on-time_completion_rate。 默认取值: 不涉及。 |
sprint_id |
否 |
String |
参数解释: 迭代ID,通过调用[获取指定项目的迭代列表]返回参数的ID获取 约束限制: 正则表达式:(([A-Za-z0-9,-]{0,32768}))。 取值范围: 不涉及。 默认取值: 不涉及。 |
dividend |
否 |
dividend object |
参数解释: 指标分子过滤条件。 约束限制: 不涉及。 |
divisor |
否 |
divisor object |
指标分母过滤条件 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
custom_field16 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field17 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field18 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field19 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field20 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field21 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field22 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field23 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field24 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field25 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field26 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field27 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field28 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field29 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field30 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field31 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field32 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field33 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field34 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field35 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field36 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field37 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field38 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field39 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field40 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
on_time |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
custom_field16 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field17 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field18 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field19 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field20 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field21 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field22 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field23 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field24 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field25 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field26 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field27 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field28 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field29 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field30 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field31 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field32 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field33 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field34 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field35 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field36 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field37 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field38 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field39 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
custom_field40 |
否 |
String |
参数解释: 自定义字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
on_time |
否 |
String |
参数解释: 是否按时。 约束限制: 正则表达式:(ontime|all)。 取值范围: ontime(按时); all(全部)。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
dividend_value |
String |
参数解释: 指标分子数值。 取值范围: 不涉及。 |
divisor_value |
String |
参数解释: 指标分母数值。 取值范围: 不涉及。 |
metric_name |
String |
参数解释: 指标名称。 取值范围: 不涉及。 |
metric_value |
String |
参数解释: 指标数值。 取值范围: 不涉及。 |
project_id |
String |
参数解释: 项目ID。 取值范围: 不涉及。 |
project_name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
Post https://{endpoint}/v1/eace9c0a00574de6878ab580daa9a317/completion-rate/query
{
"date_range" : "1598457600000,1598544000000",
"dividend" : {
"custom_field16" : "自定义字段值",
"on_time" : "ontime"
},
"divisor" : {
"custom_field16" : "自定义字段值",
"on_time" : "ontime"
},
"metric_type" : "on-time_completion_rate",
"sprint_id" : "8883443"
}
响应示例
状态码: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" : "我的项目"
}
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 48 49 50 51 52 53 54 55 56 |
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 ShowCompletionRateSolution {
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();
ShowCompletionRateRequest request = new ShowCompletionRateRequest();
request.withProjectId("{project_id}");
MetricRequest3 body = new MetricRequest3();
MetricRequest3Dividend dividendbody = new MetricRequest3Dividend();
dividendbody.withOnTime("ontime")
.withCustomField16("自定义字段值");
body.withDivisor("{\"on_time\":\"ontime\",\"custom_field16\":\"自定义字段值\"}");
body.withDividend(dividendbody);
body.withSprintId("8883443");
body.withMetricType("on-time_completion_rate");
body.withDateRange("1598457600000,1598544000000");
request.withBody(body);
try {
ShowCompletionRateResponse response = client.showCompletionRate(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 |
# 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 = ShowCompletionRateRequest()
request.project_id = "{project_id}"
dividendbody = MetricRequest3Dividend(
on_time="ontime",
custom_field16="自定义字段值"
)
request.body = MetricRequest3(
divisor="{\"on_time\":\"ontime\",\"custom_field16\":\"自定义字段值\"}",
dividend=dividendbody,
sprint_id="8883443",
metric_type="on-time_completion_rate",
date_range="1598457600000,1598544000000"
)
response = client.show_completion_rate(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 |
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.ShowCompletionRateRequest{}
request.ProjectId = "{project_id}"
onTimeDividend:= "ontime"
customField16Dividend:= "自定义字段值"
dividendbody := &model.MetricRequest3Dividend{
OnTime: &onTimeDividend,
CustomField16: &customField16Dividend,
}
var divisorMetricRequest3 interface{} = "{\"on_time\":\"ontime\",\"custom_field16\":\"自定义字段值\"}"
sprintIdMetricRequest3:= "8883443"
metricTypeMetricRequest3:= "on-time_completion_rate"
dateRangeMetricRequest3:= "1598457600000,1598544000000"
request.Body = &model.MetricRequest3{
Divisor: &divisorMetricRequest3,
Dividend: dividendbody,
SprintId: &sprintIdMetricRequest3,
MetricType: &metricTypeMetricRequest3,
DateRange: &dateRangeMetricRequest3,
}
response, err := client.ShowCompletionRate(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。