更新时间:2025-07-24 GMT+08:00
分享

实时计算单个自定义报表

功能介绍

实时计算单个自定义报表

调用方法

请参见如何调用API

URI

POST /v4/{project_id}/versions/{plan_id}/custom-reports/generate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

plan_id

String

参数解释:

测试计划id或测试版本ID,对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象,测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值

约束限制:

不涉及

取值范围:

长度11-34位字符(字母和数字)

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

约束显示:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

自定义报表的名称,由用户定义,用于表示当前创建的自定义报表

约束限制:

不涉及

取值范围:

长度为3-128字符(中文或字母)

默认取值:

不涉及

workpiece_type

String

参数解释:

工件类型(用例:case,测试套:task)

约束限制:

不涉及

取值范围:

case/task

默认取值:

不涉及

analysis_dim_row

String

参数解释:

分析维度,为自定义报表X轴

约束限制:

不涉及

取值范围:

取值需为:CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷),EXECUTETIMES(执行次数)

默认取值:

不涉及

compare_dim_column

String

参数解释:

对比维度,为自定义报表Y轴

约束限制:

需结合分析维度进行用例/测试套统计

取值范围:

取值需为(必填):CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷)

默认取值:

不涉及

filter

ReportFilter object

参数解释

过滤项

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 ReportFilter

参数

是否必选

参数类型

描述

creatorIds

String

参数解释:

自定义报表创建人用户ID,指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ownerIds

String

参数解释:

自定义报表所属人用户ID,指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ranks

String

参数解释:

测试用例级别,指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别,用逗号拼接

默认取值:

不涉及

releaseIds

String

参数解释:

需求管理中迭代计划的ID,指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个迭代ID,用逗号拼接

默认取值:

不涉及

status

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个状态ID,用逗号拼接

默认取值:

不涉及

moduleIds

String

参数解释:

需求管理中定义的模块ID,指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个模块,用逗号拼接

默认取值:

不涉及

results

String

参数解释:

测试用例结果的状态编码,指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个结果ID,用逗号拼接

默认取值:

不涉及

labelIds

String

参数解释:

测试用例关联的标签ID,指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个标签,用逗号拼接

默认取值:

不涉及

startTime

String

参数解释:

开始时间,指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

endTime

String

参数解释:

结束时间,指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

String

参数解释:

是否关联需求,指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

success|error

取值范围:

success|error

result

ResultValueCustomReportListVo object

参数解释

返回数据

取值范围

不涉及

error

ApiError object

参数解释

错误信息

取值范围

不涉及

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

表6 ResultValueCustomReportListVo

参数

参数类型

描述

total

Integer

参数解释:

起始记录数大于实际总条数时,值为0,分页请求才有此值

取值范围:

大于等于0的整数

value

CustomReportListVo object

参数解释

返回值

取值范围

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

page_size

Integer

参数解释:

每页展示条数

取值范围:

大于等于0的整数

page_no

Integer

参数解释:

页码

取值范围:

不涉及

has_more

Boolean

参数解释:

是否有更多

确实范围:

true|false

表7 CustomReportListVo

参数

参数类型

描述

id

String

参数解释:

报表id

取值范围:

不涉及

name

String

参数解释:

报表名称

取值范围:

不涉及

filter

ReportFilter object

参数解释

过滤项

取值范围

不涉及

workpiece_type

String

参数解释:

工件类型(用例:case,测试套:task)

取值范围:

case|task

analysis_dimension

String

参数解释:

分析维度

取值范围:

不涉及

compare_dimension

String

参数解释:

对比维度

取值范围:

不涉及

chart_data

Array of ReportChartDataVo objects

参数解释

报表数据

取值范围

不涉及

表8 ReportFilter

参数

参数类型

描述

creatorIds

String

参数解释:

自定义报表创建人用户ID,指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ownerIds

String

参数解释:

自定义报表所属人用户ID,指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ranks

String

参数解释:

测试用例级别,指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别,用逗号拼接

默认取值:

不涉及

releaseIds

String

参数解释:

需求管理中迭代计划的ID,指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个迭代ID,用逗号拼接

默认取值:

不涉及

status

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个状态ID,用逗号拼接

默认取值:

不涉及

moduleIds

String

参数解释:

需求管理中定义的模块ID,指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个模块,用逗号拼接

默认取值:

不涉及

results

String

参数解释:

测试用例结果的状态编码,指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个结果ID,用逗号拼接

默认取值:

不涉及

labelIds

String

参数解释:

测试用例关联的标签ID,指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个标签,用逗号拼接

默认取值:

不涉及

startTime

String

参数解释:

开始时间,指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

endTime

String

参数解释:

结束时间,指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

String

参数解释:

是否关联需求,指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及

表9 ReportChartDataVo

参数

参数类型

描述

id

String

参数解释:

报表id

取值范围:

不涉及

name

String

参数解释:

报表名称

取值范围:

不涉及

analyze_dim

ReportDimVo object

参数解释

分析维度数据

取值范围

不涉及

compare_dim

Array of ReportDimVo objects

参数解释

对比维度数据

取值范围

不涉及

表10 ReportDimVo

参数

参数类型

描述

id

String

参数解释:

id

取值范围:

不涉及

name

String

参数解释:

名称

取值范围:

不涉及

value

Integer

参数解释:

取值范围:

不涉及

表11 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

状态码:400

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:401

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:404

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

实时计算单个自定义报表

post https://{endpoint}/v4/projects/efdb403066474ab08836b9eeaaa23bca/versions/daiuyd9tqdxas/custom-reports/generate

{
  "name" : "name",
  "workpiece_type" : "case",
  "analysis_dim_row" : "name",
  "compare_dim_column" : "name",
  "filter" : {
    "creatorIds" : "1445148",
    "ownerIds" : "1445148",
    "ranks" : "1",
    "releaseIds" : "1",
    "status" : "1",
    "moduleIds" : "1",
    "results" : "1",
    "labelIds" : "1",
    "startTime" : "2020-09-08 10:42:07",
    "endTime" : "2020-09-08 10:42:07",
    "isAssociateIssue" : "true"
  }
}

响应示例

状态码:200

参数解释

实时计算单个自定义报表返回体

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

{
  "status" : "string",
  "result" : {
    "total" : 0,
    "value" : {
      "id" : "1",
      "name" : "报表名称",
      "filter" : {
        "creatorIds" : "1445148",
        "ownerIds" : "1445148",
        "ranks" : "1",
        "releaseIds" : "1",
        "status" : "1",
        "moduleIds" : "1",
        "results" : "1",
        "labelIds" : "1",
        "startTime" : "2020-09-08 10:42:07",
        "endTime" : "2020-09-08 10:42:07",
        "isAssociateIssue" : "true"
      },
      "workpiece_type" : "case",
      "analysis_dimension" : "AUTHOR",
      "compare_dimension" : "AUTHOR",
      "chart_data" : [ {
        "id" : "1",
        "name" : "报表名称",
        "analyze_dim" : {
          "id" : "1",
          "name" : "名称",
          "value" : 0
        },
        "compare_dim" : [ {
          "id" : "1",
          "name" : "名称",
          "value" : 0
        } ]
      } ]
    },
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : {
    "code" : "string",
    "reason" : "string"
  },
  "request_id" : "string"
}

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
57
58
59
60
61
62
63
64
65
66
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class ShowReportSolution {

    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);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowReportRequest request = new ShowReportRequest();
        request.withProjectId("{project_id}");
        request.withPlanId("{plan_id}");
        GenerateReportInfo body = new GenerateReportInfo();
        ReportFilter filterbody = new ReportFilter();
        filterbody.withCreatorIds("1445148")
            .withOwnerIds("1445148")
            .withRanks("1")
            .withReleaseIds("1")
            .withStatus("1")
            .withModuleIds("1")
            .withResults("1")
            .withLabelIds("1")
            .withStartTime("2020-09-08 10:42:07")
            .withEndTime("2020-09-08 10:42:07")
            .withIsAssociateIssue("true");
        body.withFilter(filterbody);
        body.withCompareDimColumn("name");
        body.withAnalysisDimRow("name");
        body.withWorkpieceType("case");
        body.withName("name");
        request.withBody(body);
        try {
            ShowReportResponse response = client.showReport(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
47
48
49
50
51
52
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowReportRequest()
        request.project_id = "{project_id}"
        request.plan_id = "{plan_id}"
        filterbody = ReportFilter(
            creator_ids="1445148",
            owner_ids="1445148",
            ranks="1",
            release_ids="1",
            status="1",
            module_ids="1",
            results="1",
            label_ids="1",
            start_time="2020-09-08 10:42:07",
            end_time="2020-09-08 10:42:07",
            is_associate_issue="true"
        )
        request.body = GenerateReportInfo(
            filter=filterbody,
            compare_dim_column="name",
            analysis_dim_row="name",
            workpiece_type="case",
            name="name"
        )
        response = client.show_report(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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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 := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowReportRequest{}
	request.ProjectId = "{project_id}"
	request.PlanId = "{plan_id}"
	creatorIdsFilter:= "1445148"
	ownerIdsFilter:= "1445148"
	ranksFilter:= "1"
	releaseIdsFilter:= "1"
	statusFilter:= "1"
	moduleIdsFilter:= "1"
	resultsFilter:= "1"
	labelIdsFilter:= "1"
	startTimeFilter:= "2020-09-08 10:42:07"
	endTimeFilter:= "2020-09-08 10:42:07"
	isAssociateIssueFilter:= "true"
	filterbody := &model.ReportFilter{
		CreatorIds: &creatorIdsFilter,
		OwnerIds: &ownerIdsFilter,
		Ranks: &ranksFilter,
		ReleaseIds: &releaseIdsFilter,
		Status: &statusFilter,
		ModuleIds: &moduleIdsFilter,
		Results: &resultsFilter,
		LabelIds: &labelIdsFilter,
		StartTime: &startTimeFilter,
		EndTime: &endTimeFilter,
		IsAssociateIssue: &isAssociateIssueFilter,
	}
	compareDimColumnGenerateReportInfo:= "name"
	analysisDimRowGenerateReportInfo:= "name"
	workpieceTypeGenerateReportInfo:= "case"
	nameGenerateReportInfo:= "name"
	request.Body = &model.GenerateReportInfo{
		Filter: filterbody,
		CompareDimColumn: &compareDimColumnGenerateReportInfo,
		AnalysisDimRow: &analysisDimRowGenerateReportInfo,
		WorkpieceType: &workpieceTypeGenerateReportInfo,
		Name: &nameGenerateReportInfo,
	}
	response, err := client.ShowReport(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

参数解释

实时计算单个自定义报表返回体

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档