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

页面报表展示

功能介绍

页面报表展示

调用方法

请参见如何调用API

URI

GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

version_id

String

参数解释:

版本id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

page_size

Long

参数解释:

每页显示的条目数量,最大支持200条

约束限制:

不涉及

取值范围:

取值范围1-200

默认取值:

不涉及

默认取值:

200

offset

Long

参数解释:

页数,page_no大于等于1值

约束限制:

不涉及

取值范围:

取值范围0-20000

默认取值:

不涉及

默认取值:

0

type

Integer

参数解释:

报表类型 1:首页用例库, 2:质量报告

约束限制:

约束限制:1:首页用例库, 2:质量报告

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

success|error

取值范围:

不涉及

result

ResultValueListCustomReportListVo object

请求返回的数据

表5 ResultValueListCustomReportListVo

参数

参数类型

描述

total

Integer

参数解释:

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

取值范围:

不涉及

value

Array of CustomReportListVo objects

参数解释:

实际的数据类型:单个对象,集合 或 NULL

取值范围:

不涉及

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表6 CustomReportListVo

参数

参数类型

描述

id

String

参数解释:

报表id

取值范围:

不涉及

name

String

参数解释:

报表名称

取值范围:

不涉及

filter

ReportFilter object

参数解释

过滤信息

取值范围

不涉及

workpiece_type

String

参数解释

工件类型

取值范围

(用例:case,测试套:task)

analysis_dimension

String

参数解释

分析维度

取值范围

不涉及

compare_dimension

String

参数解释

对比维度

取值范围

不涉及

chart_data

Array of ReportChartDataVo objects

参数解释

报表数据

取值范围

不涉及

表7 ReportFilter

参数

参数类型

描述

creatorIds

String

参数解释

创建人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ownerIds

String

参数解释

所属人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ranks

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

releaseIds

String

参数解释

releaseId

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

String

参数解释

状态

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

moduleIds

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

results

String

参数解释

结果

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

labelIds

String

参数解释

标签

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

startTime

String

参数解释

开始时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

endTime

String

参数解释

结束时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

isAssociateIssue

String

参数解释

是否关联需求

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表8 ReportChartDataVo

参数

参数类型

描述

id

String

参数解释

报表id

取值范围

不涉及

name

String

参数解释

报表名称

取值范围

不涉及

analyze_dim

ReportDimVo object

参数解释

分析维度数据

取值范围

不涉及

compare_dim

Array of ReportDimVo objects

参数解释

对比维度数据

取值范围

不涉及

表9 ReportDimVo

参数

参数类型

描述

id

String

参数解释

id

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

value

Integer

参数解释

取值范围

不涉及

状态码:400

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:401

表11 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:404

表12 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:500

表13 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

GET https://{endpoint}/73ad9ecbf32f44928b51a5d2c96720b8/versions/5d2c96720b8/custom-reports?type=1&page_no=1&page_size=10

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "value" : [ {
      "id" : "v92s00010d5on48h",
      "name" : "YQTest_UDF_REP",
      "workpiece_type" : "case",
      "analysis_dimension" : "STATUS",
      "chart_data" : [ {
        "analyze_dim" : {
          "id" : "0",
          "name" : "新建",
          "value" : 3
        }
      } ]
    } ],
    "page_size" : 5,
    "page_no" : 1
  }
}

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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class ListReportsSolution {

    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();
        ListReportsRequest request = new ListReportsRequest();
        request.withVersionId("{version_id}");
        request.withProjectId("{project_id}");
        try {
            ListReportsResponse response = client.listReports(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 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 = ListReportsRequest()
        request.version_id = "{version_id}"
        request.project_id = "{project_id}"
        response = client.list_reports(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"
    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.ListReportsRequest{}
	request.VersionId = "{version_id}"
	request.ProjectId = "{project_id}"
	response, err := client.ListReports(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档