华为云用户手册

新版界面 本章节主要介绍用户登录后，桌面常用操作。 桌面登录后，当用户名下有多个桌面时，会进入如下界面，单击任一桌面可登录桌面；当用户名下只有一台桌面时，会直接登录桌面，登录桌面后单击最小化或关闭桌面可进入如下界面。 相关操作介绍如所示。 表1 桌面操作 操作 说明 刷新 云桌面 列表。 锁定云桌面，锁定后再次登录桌面需要输入用户密码。 单击用户头像进入相关设置界面。 修改密码：用户可根据界面提示修改用户密码。 安全设置： 密钥更新：可更新系统加解密的密钥。 缓存清理：清除所有本地记录。 更多设置： 启动设置：可以设置客户端是否自动启动，开启后，启动系统时将自动运行客户端。 语言：可以设置客户端语言。 反馈中心： 日志自动收集：可以设置是否开启日志自动收集，该功能有利于统计云桌面使用情况，如日志信息，网络质量，开启有助于快速定位和解决云桌面使用过程中的问题。 日志上报：可以上报客户端日志，上报后管理员可以查看客户端日志信息。 检查更新：检查客户端是否有新版本。 关于：查看客户端版本信息。 退出账号：退出当前登录的账号。 关机：云桌面关机。 强制关机：普通关机无法生效时，可以使用强制关机。 休眠：云桌面休眠。 重启：云桌面重启。 强制重启：普通重启无法生效时，可以使用强制重启。 快照管理：快照可对您的云桌面数据备份与恢复，当云桌面发生故障或者文件损坏时，可以进行快速的数据恢复，保障数据安全。支持创建10个快照（5个系统盘+5个数据盘）。 该功能依赖管理员是否允许用户在客户端进行快照管理，如果没有该配置项请联系管理。 创建快照： 单击“创建快照”。 根据界面提示依次配置磁盘范围、系统盘快照名称、数据盘快照名称和描述。 单击“确认创建”。 恢复快照： 创建过快照后，在快照管理中可以查看已经创建快照。 单击选择需要恢复的快照。 单击“确认恢复”。 在提示界面单击“确认恢复”。 选择恢复的快照中显示恢复进度，显示最近一次恢复时间以及恢复成功后表示快照恢复完成。 自助维护：自护维护是用于应急运维，在您使用自助维护登录桌面期间，可同时求助您的租户管理员从管理面远程登录帮您解决问题。 若您希望结束授权管理员，仅需重新点击自助维护并立即关闭即可。 父主题： 常用功能配置

老版界面 本章节主要介绍用户登录后，桌面常用操作。 桌面登录后，当用户名下有多个桌面时，会进入如下界面，单击任一桌面可登录桌面；当用户名下只有一台桌面时，会直接登录桌面，登录桌面后单击最小化或关闭桌面可进入如下界面。 相关操作介绍如所示。 表1 桌面操作 操作 说明 刷新云桌面列表。 锁定云桌面，锁定后再次登录桌面需要输入用户密码。 单击用户头像进入相关设置界面。 修改密码：用户可根据界面提示修改用户密码。 启动设置：可以设置客户端是否自动启动，开启后，启动系统时将自动运行客户端。 安全设置： 密钥更新：可更新系统加解密的密钥。 缓存清理：清除所有本地记录。 反馈中心： 日志自动收集：可以设置是否开启日志自动收集，该功能有利于统计云桌面使用情况，如日志信息，网络质量，开启有助于快速定位和解决云桌面使用过程中的问题。 日志上报：可以上报客户端日志，上报后管理员可以查看客户端日志信息。 检查更新：检查客户端是否有新版本。 关于：查看客户端版本信息。 退出账号：退出当前登录的账号。 关机：云桌面关机。 强制关机：普通关机无法生效时，可以使用强制关机。 休眠：云桌面休眠。 重启：云桌面重启。 强制重启：普通重启无法生效时，可以使用强制重启。 快照管理：快照可对您的云桌面数据备份与恢复，当云桌面发生故障或者文件损坏时，可以进行快速的数据恢复，保障数据安全。支持创建10个快照（5个系统盘+5个数据盘）。 该功能依赖管理员是否允许用户在客户端进行快照管理，如果没有该配置项请联系管理。 创建快照： 单击“创建快照”。 根据界面提示依次配置磁盘范围、系统盘快照名称、数据盘快照名称和描述。 单击“确认创建”。 恢复快照： 创建过快照后，在快照管理中可以查看已经创建快照。 单击选择需要恢复的快照。 单击“确认恢复”。 在提示界面单击“确认恢复”。 选择恢复的快照中显示恢复进度，显示最近一次恢复时间以及恢复成功后表示快照恢复完成。 自助维护：自护维护是用于应急运维，在您使用自助维护登录桌面期间，可同时求助您的租户管理员从管理面远程登录帮您解决问题。 若您希望结束授权管理员，仅需重新点击自助维护并立即关闭即可。 父主题： 常用功能配置

新版界面 本章节主要介绍在桌面内使用灵动球功能。 安卓TC、移动端及CT3200瘦终端暂不支持灵动球功能。 登录桌面后，界面展示灵动球图标。 灵动球无云应用中心时：单击灵动球，查看灵动球功能栏。 灵动球有应用中心时：单击灵动球，查看灵动球功能栏。 鼠标在灵动球功能栏右侧拖动可以拉伸边框，功能可以平铺展示。 将灵动球拖至云桌面顶部，桌面无操作后等待时间，灵动球会收缩至云桌面顶部，单击可以再次显示灵动球。 双显接入云桌面，不支持将灵动球拖至副屏。 表1 桌面灵动球功能介绍 功能 说明 双击查看网络数据及资源负载状况，如表3所示。 单击可以查看云应用中心。 单击显示该用户下的桌面列表，当有多个桌面时，单击对应桌面可快速切换到对应桌面。 单击可以“发起协同”或“加入协同”。 单击进入设置界面，详细介绍如表2所示。 更多设置，单击可以查看如下操作： Ctrl+Alt+Del组合键。 全屏/窗口化：单击可以在全屏和窗口化之间自由切换。 单击最小化桌面。 单击关闭桌面。 表2 设置项介绍 设置项 说明 多屏 多显示器连接：可扩展桌面到多显示器中，配置将在重新登录后生效。 外接设备 查看已连接的设备，有新设备连接时单击“刷新”可查看，鼠标模式建议保持默认值：自适应相对模式。 高级 客户端窗口前置：开启后，客户端将始终保持在所有窗口的最上层。 启用硬件加速：关闭硬件加速会降低图形处理能力。 帧率实时显示：开启后桌面上会实时显示帧率。 悬浮栏自动显示：开启后桌面中间上方的悬浮栏会隐藏，鼠标移动到对应位置后才会显示。 浮动栏大小档位：默认为2，可根据实际需要调整浮动栏的显示大小。 缩放比自适应：建议保持默认开启。 录屏图标显示：开启后，桌面如果在录屏会出现图标提醒。 关于 查看客户端版本号和版权信息。 表3 性能数据视图 性能指标 指标类型 指标定义 网络数据 网络时延 云桌面在使用过程中，网络数据在传输过程中所需的时间延迟。 E2E时延 客户端到服务端的时延。 网络丢包 在连接应用使用过程中，测试网络时所丢失数据包数量占所发送数据包的比率。 网络抖动 云桌面在使用过程中，网络的最大延迟与最小延迟的时间差。 帧率 云桌面使用过程中显示的帧率大小。 上行流量 云桌面在使用过程中的发送流量。 下行流量 云桌面在使用过程中的接收流量。 资源负载 云端 云桌面服务器的CPU和内存利用率。 本地 本地电脑端的CPU和内存利用率。 CPU 云桌面的CPU使用率。 内存 云桌面的内存使用率。 父主题： 桌面使用助手

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "case_completion_rate" : { "total" : 2, "completion_rate" : "100.0%", "status_number_list" : [ { "name" : "完成", "value" : 2 } ] }, "case_pass_rate" : { "pass_rate" : "100.0%", "result_number_list" : [ { "name" : "成功", "value" : 2 } ] } } } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueHomePageOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueHomePageOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value HomePageOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编号 has_more Boolean 是否有更多 表6 HomePageOverviewVo 参数 参数类型 描述 case_completion_rate CaseCompletionRateVo object 计算用例完成率 case_pass_rate CasePassRateVo object 计算用例通过率 defect_status DefectStatusVo object 统计缺陷信息，组装缺陷状态分组信息 defect_severity DefectSeverityVo object 统计缺陷信息，组装缺陷重要程度分组信息 表7 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表8 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表9 DefectStatusVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 status_number_list Array of NameAndValueVo objects 每种状态的名称和对应的数目 表10 DefectSeverityVo 参数 参数类型 描述 total Integer 缺陷数 severity_number_list Array of NameAndValueVo objects 每种重要程度的名称和对应的数目 表11 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表12 ApiError 参数 参数类型 描述 code String 只有对外的接口才会返回此内容 reason String 业务失败的提示内容 状态码：400 表13 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：401 表14 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：404 表15 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：500 表16 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 version_uri 否 String 参数解释: 版本或迭代URI 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 module_id 否 String 参数解释: 模块ID，模块的唯一标识，需从需求管理获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 fixed_version_id 否 String 参数解释: 计划迭代ID，模块的唯一标识，需从需求管理获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 owner_id 否 String 参数解释: 用户ID，用户的唯一标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 comment 是 String 参数解释: 评论 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 notifier 否 Array of strings 参数解释: 通知人列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 version_uri 否 String 参数解释: 分支uri/测试计划uri 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueTestCaseCommentVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTestCaseCommentVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TestCaseCommentVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编码 has_more Boolean 是否有更多 表6 TestCaseCommentVo 参数 参数类型 描述 uri String 用例评论id creator String 创建者id comment String 评论内容 notifier Array of strings 评论通知人 test_case_uri String 用例di create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目uuid version_uri String 迭代,分支uri display_name String 是否显示通知人 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "spec_code" : "apitest", "domain_order_status" : "close", "resource_id" : "4f8da8d94d344547a212aed7613e99e2", "concurrent_number" : 0, "concurrent_testcase" : 0 } } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

URI GET /v1/echotest/concurrency/status 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 test_type 否 String test_type

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 接口返回状态，ok-成功，failed-失败 约束限制 不涉及 取值范围 ok,failed 默认取值 ok result Object 参数解释 租户的接口测试并发套餐内容 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 表5 ListCucrrencyPackageResult 参数 参数类型 描述 spec_code String 参数解释 套餐编码 约束限制 不涉及 取值范围 200个字符组成的字符串 默认取值 不涉及 domain_order_status String 参数解释 套餐状态 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 resource_id String 参数解释 资源记录id 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 concurrent_number Number 参数解释 并发套件数目 约束限制 不涉及 取值范围 true,false 默认取值 不涉及 concurrent_testcase Number 参数解释 并发测试用例数目 约束限制 不涉及 取值范围 true,false 默认取值 不涉及 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 返回状态码，OK表示导出测试报告成功 result String 测试报告导出的结果 表5 ExportSubTaskresult 参数 参数类型 描述 export_key String 导出测试报告的id 状态码：201 Created 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 from 否 Integer 从倒数第一个开 time_zone 否 String 导出数据的时区 to 否 Integer 到正数第一个

URI POST /v1/projects/{service_id}/task/{task_id}/export 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 task_id 是 String 任务Id

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "uri" : "v92u00010e7dkink", "type" : "TestVersion", "author" : "f3b807a0d249424fa36a0d804110c4ed", "name" : "这是一个测试计划", "version" : "基线_版本", "owner" : "f3b807a0d249424fa36a0d804110c4ed", "iterations" : "[]", "region" : "cn-north-7", "last_modifier" : "f3b807a0d249424fa36a0d804110c4ed", "last_modified" : "2025-04-28 16:46:40", "last_change_time" : "2025-04-28 16:46:40", "version_uri" : "v92s00010db208e5", "parent_uri" : "v92s00010db208e5", "parent_path" : "/dc3f9aa646ad4707831080d3fcce474d/v92s00010db208e5/", "creation_version_uri" : "v92s00010db208e5", "creation_date" : "2025-04-28 16:46:40", "is_master" : 0, "is_iterator" : 1, "plan_start_date" : "2025-04-28 00:00:00", "plan_end_date" : "2025-04-28 23:59:59", "service_id" : "dc3f9aa646ad4707831080d3fcce474d", "service_name" : "【车联网示例项目】车联网云服务-GJX", "schema_no" : 1, "current_stage" : "create", "service_types" : "[\"0\",\"11\",\"1\",\"100\",\"6\",\"8\",\"32\"]", "risk_rating" : 0, "project_uuid" : "dc3f9aa646ad4707831080d3fcce474d" } } }

请求示例 post https://{endpoint}/GT3KServer/v4/iterators?branch_uri=v92s00010db208e5 { "project_uuid" : "9a5b66157ff44f6f80ce5f0fd1709f21", "name" : "是是是", "owner" : "6a6c782cd85f414ea20652e5f8ac7882", "version" : "基线_版本", "current_stage" : "", "plan_start_date" : "2025-04-07 00:00:00", "plan_end_date" : "2025-04-24 23:59:59", "service_types" : [ 0, 1, 8, 11, 32, 100, 6 ], "iterations" : [ ], "description" : "", "issue_list" : [ { "work_item_id" : "sasda1111", "has_child" : false, "is_open" : false } ], "plan_start_timestamp" : 1743955200000, "plan_end_timestamp" : 1745510399000, "pi_id" : null }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueTestVersionVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueTestVersionVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TestVersionVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编号 has_more Boolean 是否有更多 表7 TestVersionVo 参数 参数类型 描述 uri String 参数解释: 资源URI 取值范围: 11-34位长度的字母、数字组成的字符串 type String 参数解释: 资源类型 取值返回: TestVersion author String 参数解释: 创建人 取值范围: 不涉及 name String 参数解释: 名称 取值范围: 不涉及 rank Integer 参数解释: 级别 取值范围: 1|2|3|4 version String 参数解释: 待测版本 取值范围: 不涉及 owner String 参数解释: 处理者ID 取值范围: 不涉及 creator String 参数解释: 创建人ID 取值范围: 不涉及 iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 表8 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表12 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：200 OK { "result" : { "value" : [ { "uri" : "v901106fd4f7tosm", "updator" : { "id" : "85f7cd3cd8784307a5bb194321bef3c1", "name" : "wtt_apitest" }, "table_field_name" : "name", "value_type" : "text", "value_type_name" : "单行文本", "is_system" : 1, "is_display" : 1, "is_required" : 1, "sort_numb" : 1, "resource_type" : "TestCase", "creator" : { "id" : "85f7cd3cd8784307a5bb194321bef3c1", "name" : "wtt_apitest" }, "update_time_stamp" : 1737507973000, "project_uuid" : "761e569574894180b3ecadc9d9df52b6" } ] } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListProjectFieldConfigVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueListProjectFieldConfigVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ProjectFieldConfigVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ProjectFieldConfigVo 参数 参数类型 描述 uri String 字段配置URI标识 updator NameAndIdVo object 参数解释 服务类型信息 取值范围 不涉及 description String 描述 customName String 项目用例自定义字段名称 table_field_name String 字段名（对应后端参数名） value_type String 字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。 value_type_name String 字段类型国际化名称 is_system Integer 是否系统字段 is_display Integer 是否显示 is_required Integer 是否必填 sort_numb Integer 顺序数值 default_value String 默认值 custom_field_uri String 扩展字段uri(用于连表查扩展字段) resource_type String 资源类型 creator NameAndIdVo object 参数解释 服务类型信息 取值范围 不涉及 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 project_uuid String 项目ID option_vos Array of ProjectFieldConfigOptionVo objects 可选项 custom_field_id Integer 项目用例自定义字段id（1-25数字） custom_field_name String 项目用例自定义字段名称 custom_field_param String 项目用例自定义字段入参或者返回参数名称 表6 ProjectFieldConfigOptionVo 参数 参数类型 描述 uri String 字段选项URI标识.新增不传，修改、删除使用必传 name String 可选项名称 code String 可选项code值 updator NameAndIdVo object 参数解释 服务类型信息 取值范围 不涉及 description String 描述 flag Integer 修改标识，0：不可修改 1：可修改，用于结果和状态的选项值 sort_numb Integer 顺序数值 creator NameAndIdVo object 参数解释 服务类型信息 取值范围 不涉及 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 表7 NameAndIdVo 参数 参数类型 描述 id String 参数解释 ID 取值范围 不涉及 name String 参数解释 名称 取值范围 不涉及 表8 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表12 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

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

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error; result VersionTestCasesChangeStatisticsVo object 请求返回的数据类型 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表4 VersionTestCasesChangeStatisticsVo 参数 参数类型 描述 add_testcases_number Integer 新增用例数 reuse_testcases_number Integer 复用用例数 modifying_testcases_number Integer 修改用例数 update_date_timestamp Long 修改时间时间戳 update_date String 修改时间 表5 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：200 OK { "result" : { "add_testcases_number" : 1, "reuse_testcases_number" : 0, "modifying_testcases_number" : 0, "update_date_timestamp" : 1740991906000, "update_date" : "2025-03-03 16:51:46" } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 comment 是 String 参数解释: 评论 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 notifier 否 Array of strings 参数解释: 通知人列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 version_uri 否 String 参数解释: 分支uri/测试计划uri 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueTestCaseCommentVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTestCaseCommentVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TestCaseCommentVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编码 has_more Boolean 是否有更多 表6 TestCaseCommentVo 参数 参数类型 描述 uri String 用例评论id creator String 创建者id comment String 评论内容 notifier Array of strings 评论通知人 test_case_uri String 用例di create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目uuid version_uri String 迭代,分支uri display_name String 是否显示通知人 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

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

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "uri" : "v92s00010e7ddfsn", "type" : "TestVersion", "author" : "f3b807a0d249424fa36a0d804110c4ed", "name" : "cxc", "region" : "cn-north-7", "last_modifier" : "f3b807a0d249424fa36a0d804110c4ed", "last_modified" : "2025-04-28 16:42:48", "last_change_time" : "2025-04-28 16:42:48", "version_uri" : "dc3f9aa646ad4707831080d3fcce474d", "parent_uri" : "dc3f9aa646ad4707831080d3fcce474d", "parent_path" : "/dc3f9aa646ad4707831080d3fcce474d/", "creation_version_uri" : "dc3f9aa646ad4707831080d3fcce474d", "creation_date" : "2025-04-28 16:42:48", "is_master" : 0, "is_iterator" : 0, "service_id" : "dc3f9aa646ad4707831080d3fcce474d", "service_name" : "【车联网示例项目】车联网云服务-GJX", "schema_no" : 1, "risk_rating" : 0, "project_uuid" : "dc3f9aa646ad4707831080d3fcce474d" } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueTestVersionVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表4 ResultValueTestVersionVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TestVersionVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编号 has_more Boolean 是否有更多 表5 TestVersionVo 参数 参数类型 描述 uri String 参数解释: 资源URI 取值范围: 11-34位长度的字母、数字组成的字符串 type String 参数解释: 资源类型 取值返回: TestVersion author String 参数解释: 创建人 取值范围: 不涉及 name String 参数解释: 名称 取值范围: 不涉及 rank Integer 参数解释: 级别 取值范围: 1|2|3|4 version String 参数解释: 待测版本 取值范围: 不涉及 owner String 参数解释: 处理者ID 取值范围: 不涉及 creator String 参数解释: 创建人ID 取值范围: 不涉及 iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 表6 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 名称 number 否 String 开发分支名称 is_master 否 String 是否为Master分支 pbi_id 否 String PBI ID pbi_name 否 String PBI信息 plan_start_date 否 String 开始时间 plan_start_timestamp 否 Long 开始时间戳 plan_end_date 否 String 结束时间 plan_end_timestamp 否 Long 结束时间戳 asyn_git 否 String 是否同步git库 project_uuid 是 String 项目ID（云龙场景，传入微服务ID） project_name 否 String 项目名称（云龙场景，传入微服务名）