华为云用户手册

主机安全 主机安全是提升主机整体安全性的服务，通过主机管理、风险预防、入侵检测、高级防御、安全运营、网页防篡改功能，全面识别并管理主机中的信息资产，实时监测主机中的风险并阻止非法入侵行为，帮助企业构建服务器安全体系，降低当前服务器面临的主要安全风险。 在主机中安装Agent后，您的主机将受到HSS云端防护中心全方位的安全保障，在安全控制台可视化界面上，您可以统一查看并管理同一区域内所有主机的防护状态和主机安全风险。 主机安全的工作原理如图1所示。 图1 工作原理

暴力破解防护限制 使用鲲鹏计算EulerOS（EulerOS with ARM）操作系统的主机，在遭受SSH账户破解攻击时，HSS不会对攻击IP进行拦截，仅支持对攻击行为进行告警。 为Windows主机开启防护时，需要授权开启Windows防火墙，且使用主机安全服务期间请勿关闭Windows防火墙。 如果关闭Windows防火墙，HSS无法拦截账户暴力破解的攻击源IP；即使手动关闭后开启Windows防火墙，也可能导致HSS不能拦截账户暴力破解的攻击源IP。

Agent限制 如果服务器安装了360安全卫士、腾讯管家、McAfee软件等第三方安全防护软件，请先卸载再安装主机安全Agent；第三方安全软件与主机安全Agent存在不兼容的情况，会影响主机安全的防护功能。 主机或容器节点安装Agent后，Agent可能修改如下系统文件或配置： Linux系统文件： /etc/hosts.deny /etc/hosts.allow /etc/rc.local /etc/ssh/sshd_config /etc/pam.d/sshd /etc/docker/daemon.json /etc/sysctl.conf /sys/fs/cgroup/cpu/（在该目录下新建HSS进程的子目录） /sys/kernel/debug/tracing/instances（在该目录下新建 CS A实例） Linux系统配置：iptables规则 Windows系统配置： 防火墙规则 系统登录事件审计策略 Windows Remote Management信任主机列表

操作系统限制 主机安全服务的Agent、系统 漏洞扫描 功能对操作系统有一定限制，部分操作系统暂不支持。 HSS对操作系统的限制请参见： 表 HSS对Windows操作系统的限制（X86架构） 表 HSS对Linux操作系统的限制（X86架构） 表 HSS对Linux操作系统的限制（ARM架构） CentOS 6.x版本由于Linux官网已停止更新维护，主机安全服务也不再支持CentOS 6.x及以下的系统版本，谢谢您的理解！ 本文表格中使用的标识含义如下： √表示支持 ×表示不支持 表3 HSS对Windows操作系统的限制（X86架构） 操作系统版本 Agent支持情况 系统漏洞扫描支持情况 Windows 10（64位） √ 说明： 仅支持华为云 云桌面 使用该操作系统。 × Windows 11（64位） √ 说明： 仅支持华为云云桌面使用该操作系统。 × Windows Server 2012 R2 标准版 64位英文(40GB) √ √ Windows Server 2012 R2 标准版 64位简体中文(40GB) √ √ Windows Server 2012 R2 数据中心版 64位英文(40GB) √ √ Windows Server 2012 R2 数据中心版 64位简体中文(40GB) √ √ Windows Server 2016 标准版 64位英文(40GB) √ √ Windows Server 2016 标准版 64位简体中文(40GB) √ √ Windows Server 2016 数据中心版 64位英文(40GB) √ √ Windows Server 2016 数据中心版 64位简体中文(40GB) √ √ Windows Server 2019 数据中心版 64位英文(40GB) √ √ Windows Server 2019 数据中心版 64位简体中文(40GB) √ √ Windows Server 2022 数据中心版 64位英文(40GB) √ √ Windows Server 2022 数据中心版 64位简体中文(40GB) √ √ 表4 HSS对Linux操作系统的限制（X86架构） 操作系统版本 Agent支持情况 系统漏洞扫描支持情况 CentOS 7.4（64位） √ √ CentOS 7.5（64位） √ √ CentOS 7.6（64位） √ √ CentOS 7.7（64位） √ √ CentOS 7.8（64位） √ √ CentOS 7.9（64位） √ √ CentOS 8.1（64位） √ × CentOS 8.2（64位） √ × CentOS 8（64位） √ × CentOS 9（64位） √ × Debian 9（64位） √ √ Debian 10（64位） √ √ Debian 11.0.0（64位） √ √ Debian 11.1.0（64位） √ √ EulerOS 2.2（64位） √ √ EulerOS 2.3（64位） √ √ EulerOS 2.5（64位） √ √ EulerOS 2.7（64位） √ × EulerOS 2.9（64位） √ √ Fedora 28（64位） √ × Fedora 31（64位） √ × Fedora 32（64位） √ × Fedora 33（64位） √ × Fedora 34（64位） √ × Ubuntu 16.04（64位） √ √ Ubuntu 18.04（64位） √ √ Ubuntu 20.04（64位） √ √ Ubuntu 22.04（64位） √ √ Ubuntu 24.04（64位） √ 说明： 暂不支持暴力破解检测。 × Red Hat 7.4（64位） √ × Red Hat 7.6（64位） √ × Red Hat 8.0（64位） √ × Red Hat 8.7（64位） √ × OpenEuler 20.03 LTS（64位） √ × OpenEuler 22.03 SP3（64位） √ × OpenEuler 22.03（64位） √ × AlmaLinux 8.4（64位） √ √ AlmaLinux 9.0（64位） √ × RockyLinux 8.4（64位） √ × RockyLinux 8.5（64位） √ × RockyLinux 9.0（64位） √ × HCE 1.1（64位） √ √ HCE 2.0（64位） √ √ SUSE 12 SP5（64位） √ √ SUSE 15（64位） √ × SUSE 15 SP1（64位） √ √ SUSE 15 SP2（64位） √ √ SUSE 15 SP3（64位） √ × SUSE 15.5（64位） √ × SUSE 15 SP6（64位） √ 说明： 暂不支持暴力破解检测。 × Kylin V10（64位） √ √ Kylin V10 SP3（64位） √ × 统信UOS 1050u2e √ 说明： 暂不支持文件逃逸检测。 √ 表5 HSS对Linux操作系统的限制（ARM架构） 操作系统版本 Agent支持情况 系统漏洞扫描支持情况 CentOS 7.4（64位） √ √ CentOS 7.5（64位） √ √ CentOS 7.6（64位） √ √ CentOS 7.7（64位） √ √ CentOS 7.8（64位） √ √ CentOS 7.9（64位） √ √ CentOS 8.0（64位） √ × CentOS 8.1（64位） √ × CentOS 8.2（64位） √ × CentOS 9（64位） √ × EulerOS 2.8（64位） √ √ EulerOS 2.9（64位） √ √ Fedora 29（64位） √ × Ubuntu 18.04（64位） √ × Ubuntu 24.04（64位） √ 说明： 暂不支持暴力破解检测。 × Kylin V7（64位） √ × Kylin V10（64位） √ √ HCE 2.0（64位） √ √ 统信UOS V20（64位） √ √ 说明： 仅统信UOS V20服务器E版、D版支持系统漏洞扫描。

容器防护限制 HSS支持对华为云集群容器、第三方云集群容器以及线下IDC自建集群容器进行防护。具体支持防护的容器类型如表 容器防护限制所示。 表1 容器防护限制 类别 支持防护的容器类型 约束与限制 华为云 CCE集群容器 非集群纳管的容器 容器运行时限制：Docker、Containerd。 集群类型限制：CCE标准版、 CCE Turbo 版。 节点资源剩余要求：内存必须50MiB及以上，CPU必须200毫核(m)及以上。 资源占用限制：将集群接入HSS时，HSS会在集群上创建HSS的命名空间。 第三方 阿里云集群容器 腾讯云集群容器 微软云集群容器 自建集群容器 IDC自建集群容器 非集群纳管的容器 集群编排平台限制：1.19及以上Kubernetes。 节点操作系统限制：Linux系统。 节点规格要求：CPU必须2核及以上，内存必须4GiB及以上，系统盘必须40GiB及以上，数据盘必须100GiB及以上。

防护配额限制 在主机安全服务中，防护配额是分配给主机或容器节点的防护资源，每台主机或容器节点开启防护都需要绑定一个防护配额。 以下是防护配额的一些使用限制： 防护配额不能跨区域使用。 购买防护配额时，请正确选择区域信息。不同类型主机，选择区域请参考表 防护配额区域限制。 表2 防护配额区域限制 类别 主机类型 防护配额区域说明 华为云 华为云弹性 云服务器ECS 华为云裸金属服务器BMS 华为云云耀云服务器HECS 华为云 云桌面Workspace 请选择ECS/BMS/HECS/Workspace所在区域购买主机防护配额。 HSS不支持跨区域使用，如果主机与防护配额不在同一区域，请退订配额后，重新购买主机所在区域的配额。 第三方 第三方云主机 线下IDC 第三方主机购买配额时选择的区域因接入HSS的方式而不同： 公网接入：即主机能够访问公网，通过公网接入HSS。请选择主机所在的区域购买防护配额。 专线代理接入：即主机不能访问公网，需要通过“专线+代理”的方式接入HSS。目前仅部分区域支持通过专线代理方式将第三方主机接入HSS，具体区域请参见哪些区域支持通过专线代理接入第三方主机?。 请在支持通过专线代理方式将第三方主机接入HSS的区域购买主机防护配额，然后使用第三方主机的Agent安装方式，将主机接入配额所在区域。 一个防护配额只能绑定一个主机或一个容器节点。 一个区域最多支持购买50000个防护配额。 防护配额购买完成后，您的主机或容器还未被防护，请前往HSS控制台参考界面提示为主机或容器安装Agent并开启防护。

主机防护限制 HSS支持对华为云主机、第三方云主机和线下数据中心（IDC）进行防护，具体支持防护的主机类型包括： 华为云 华为云弹性云服务器（Elastic Cloud Server，ECS） 华为云裸金属服务器（Bare Metal Server，BMS） 华为云云耀云服务器（Hyper Elastic Cloud Server，HECS） 华为云云桌面（Workspace） 第三方 第三方云主机 线下IDC

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于20000 limit 是 Integer 每页显示的条目数量,最大支持100条 execute_start_time 是 String 用例执行时间段开始 execute_end_time 是 String 用例执行时间段截止

请求示例 查询时段内用例的执行情况 post https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/testcases/execute-info/statistic-by-user { "offset" : 0, "limit" : 10, "execute_start_time" : "2023-01-01T00:00:00+08:00", "execute_end_time" : "2023-01-01T23:59:59+08:00" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数大于实际总条数时，值为0。 values Array of ExternalUserExecuteInfo objects 时段内用例的执行情况 表5 ExternalUserExecuteInfo 参数 参数类型 描述 executor NameAndIdVo object 执行人信息 execute_count Integer 执行用例数 表6 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 testsuite_id String 生成的测试套的id testcase_ids Array of strings 生成的测试用例uri列表 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_detail Array of CommonResponseDetail objects 接口调用失败的详情信息，非参数校验失败没有该结构 error_msg String 接口调用失败错误信息 表6 CommonResponseDetail 参数 参数类型 描述 step_name String 记录错误步骤名称 testcase_name String 用例名称 fail_content String 记录实际错误内容值 fail_keys String 记录包含错误的关键字 fail_source String 记录错误部位header name等 fail_type String 记录错误类型 stage String 记录包含错误阶段 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 testsuite_name 是 String 要生成的测试套名称 repository_id 是 String 仓库id repository_branch 是 String 仓库分支 file_path 是 String 仓库中yaml或json文件的相对路径，仅支持swagger 2.0版本的yaml和json文件

涉及接口 用户用例操作包括，创建测试用例、更新测试用例、批量删除测试用例、获取测试用例详情、批量执行用例接口、批量更新测试用例结果，涉及接口如下： 创建自定义测试服务类型用例：新建用例进行测试。 更新自定义测试服务类型用例：修改用例信息。 批量删除自定义测试服务类型用例：可同时删除多个用例。 获取测试用例详情：单个查询用例详情。 批量执行测试用例：同时执行多个测试用例。 批量更新测试用例结果：用例结果产生后，同时更新多个测试用例结果。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String 对外时：success|error; 对内时：ok|failed 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 业务失败的提示内容

URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本id 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 每页显示的条目数量,最大支持200条 offset 是 Long 页数，page_no大于等于1 type 是 Integer 报表类型 1：首页用例库， 2：质量报告

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueRequirementsOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 表7 ResultValueRequirementsOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value RequirementsOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表8 RequirementsOverviewVo 参数 参数类型 描述 total_number Integer 质量报告需求测试情况总数 requirement_overview_list Array of RequirementOverviewVo objects 质量报告需求测试情况列表 表9 RequirementOverviewVo 参数 参数类型 描述 name String 需求名称 workitem_id String 需求id sequence_id String 需求序列编号 board_id String 看板需求id tracker_id String 需求类型id tracker_name String 需求类型 relate_case_number Integer 需求关联用例总数 case_pass_vo CasePassVo object 需求关联用例通过情况 case_execute_vo CaseExecuteVo object 需求关联用例执行率情况 relate_defect_number Integer 需求关联缺陷总数 表10 CasePassVo 参数 参数类型 描述 pass_rate String 需求关联用例通过率 result_number_list Array of NameAndValueVo objects 需求关联用例结果与对应的用例数目列表 表11 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表12 CaseExecuteVo 参数 参数类型 描述 execute_rate String 需求关联用例执行率 executed_number Integer 需求关联已执行用例总数 not_executed_number Integer 需求关联未执行用例总数 表13 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表14 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表15 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表16 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表17 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

URI POST /testreport/v4/{project_id}/versions/{version_id}/requirements/overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本id

请求示例 实时计算单个自定义报表 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 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueCustomReportListVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 表6 ResultValueCustomReportListVo 参数 参数类型 描述 total Integer 起始记录数大于实际总条数时，值为0，分页请求才有此值 value CustomReportListVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 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 报表数据 表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 接口调用失败错误信息

响应示例 状态码： 200 OK { "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" }

请求参数 表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 默认取值: 不涉及

URI POST /v4/{project_id}/versions/{plan_id}/custom-reports/generate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_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位字符（字母和数字） 默认取值: 不涉及

请求示例 查询用户用例关联缺陷的统计信息 post https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/testcases/defect-info/list-by-creation-time { "offset" : 0, "limit" : 10, "branch_id" : "v8140000ur3l895k", "create_testcase_start_time" : "2023-01-01T00:00:00+08:00", "create_testcase_end_time" : "2023-01-01T23:59:59+08:00", "associate_defect_start_time" : "2023-01-01T00:00:00+08:00", "associate_defect_end_time" : "2023-01-01T23:59:59+08:00" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数大于实际总条数时，值为0。 values Array of ExternalUserCaseAndDefect objects 查询用户用例关联缺陷的统计信息 表5 ExternalUserCaseAndDefect 参数 参数类型 描述 creator NameAndIdVo object 创建者信息 defect_count Integer 缺陷数 defect_ids Array of strings 缺陷ID列表 testcase_id String 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。 branch_id String 分支ID 表6 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

响应示例 状态码： 200 OK { "total" : 1, "values" : [ { "creator" : { "id" : "id", "name" : "name" }, "defect_count" : 1, "defect_ids" : [ "1001" ], "testcase_id" : "v8120ur97un641hi", "branch_id" : "v8140000ur3l895k" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 是 Integer 每页显示的条目数量,最大支持100条 branch_id 否 String 分支ID create_testcase_start_time 是 String 用例创建时间段开始 create_testcase_end_time 是 String 用例创建时间段截止 associate_defect_start_time 否 String 缺陷关联时间段开始 associate_defect_end_time 否 String 缺陷关联时间段截止

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 testcases Array of TestCaseVo objects 用例详情 total_count Integer 用例总数 page_no Integer 页码 page_size Integer 每页数量 表5 TestCaseVo 参数 参数类型 描述 uri String 用例ID number String 用例编号 name String 用例名称 rank String 用例等级 dr_relation_id String 工作项id status_code String 状态ID status_name String 状态名称 author String 创建人名称 author_id String 创建人ID owner String 处理人名称 project_uuid String 项目ID test_type String 测试类型 creation_date String 创建时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

响应示例 状态码： 200 OK { "environments" : [ { "environment_id" : "ff4893796ee1a8aa009ff3a470de55d8", "environment_name" : "默认环境", "environment_description" : "默认环境", "is_default" : true } ], "offset" : 0, "limit" : 1, "total_count" : 50 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 environments Array of Environment objects 环境分组列表 offset Long 偏移量，表示从此偏移量开始查询，offset大于等于0 limit Long 每页显示的条目数量,最大支持200条 total_count Long 环境分组总条数 表5 Environment 参数 参数类型 描述 environment_id String 环境分组id environment_name String 环境分组名 environment_description String 环境分组描述 is_default Boolean 是否是默认环境 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

URI GET /v1/projects/{project_id}/environments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 起始偏移量，表示从此偏移量开始查询， offset大于等于0 limit 是 Long 每页显示的条目数量,最大支持200条