华为云用户手册

DSC支持的数据源类型及版本 表1 DSC支持的数据源类型及版本 数据类型 数据源类型 版本 数据库 MySQL 5.6、5.7、5.8、8.0 SQL Server 2017_SE、2017_EE、2017_WEB 2016_SE、2016_EE、2016_WEB 2014_SE、2014_EE 2012_SE、2012_EE、2012_WEB 2008_R2_EE、2008_R2_WEB PostgreSQL 15、14、13、12、11、10、9.6、9.5、9.4、9.1、1.0 TDSQL 10.3.X Oracle 11、12 DDS 4.2、4.0、3.4 KingBase V8 GaussDB 1.3、1.4、2.7 DMDBMS 7、8 DWS 8.1.X 大数据 ElasticSearch 5.x、6.x、7.x DLI 1.0 Hive 1.0 MRS -Hive 3.x Hbase 1.0 OBS OBS V3

DSC支持的华为云数据源 关系型数据库（Relational Database Service，RDS） 对象存储服务 （Object Storage Service，OBS） OBS只支持桶列表，不支持并行文件系统。 数据仓库 服务（Data Warehouse Service，DWS） 文档数据库服务（Document Database Service，DDS） MapReduce服务 （MapReduce Service，MRS） 云搜索服务 （Cloud Search Service， CSS ） 数据湖探索 服务（Data Lake Insight，DLI） 云数据库服务（GaussDB） 弹性云服务器（Elastic Cloud Server ，E CS ）的自建数据库，支持的自建数据库版本如表1所示。 裸金属服务器（Bare Metal Server，BMS）的自建数据库 云日志 服务（Log Tank Service，LTS）

监控指标 指标ID 指标名称 含义 取值范围 单位 进制 测量对象（维度） 监控周期（原始指标） connect_status 站点连接状态 该指标为站点云边网络连接状态。 0代表站点断连，存在故障。 1代表站点部分断连，亚健康状态。 2代表站点状态正常。 ≥ 0 - 不涉及 CloudPond 1分钟 vcpu_util vCPU利用率 该指标为从站点层面采集的vCPU使用率。 计算公式：CloudPond vCPU已用数量 / vCPU总量 ≥ 0 % 不涉及 CloudPond 5分钟 mem_util 内存利用率 该指标为从站点层面采集的内存使用率。 计算公式：CloudPond 存使用量/内存总量 ≥ 0 % 不涉及 CloudPond 5分钟 vcpu_used vCPU已用数量 该指标为从站点层面采集的vCPU使用数量。 ≥ 0 count 不涉及 CloudPond 5分钟 vcpu_total vCPU总量 该指标为从站点层面采集的vCPU总量。 ≥ 0 count 不涉及 CloudPond 5分钟 mem_used 内存使用量 该指标为从站点层面采集的内存使用量。 ≥ 0 GiB 不涉及 CloudPond 5分钟 mem_total 内存总量 该指标为从站点层面采集的内存总量。 ≥ 0 GiB 不涉及 CloudPond 5分钟 capacity_used 存储资源使用量 该指标为从站点层面采集的存储使用量。 ≥ 0 GiB 不涉及 CloudPond 5分钟 capacity_total 存储资源可用总量 该指标为从站点层面采集的存储总量。 ≥ 0 GiB 不涉及 CloudPond 5分钟 vcpu_used_perflavor 云主机-单实例类型vCPU使用量 该指标为单实例类型vCPU使用数量。 ≥ 0 count 不涉及 CloudPond，云主机资源 5分钟 vcpu_total_perflavor 云主机-单实例类型vCPU总量 该指标为单实例类型vCPU总量。 ≥ 0 count 不涉及 CloudPond云主机资源 5分钟 vcpu_util_perflavor 云主机-单实例类型vCPU利用率 该指标为单实例类型vCPU使用率。 计算公式：云主机-单实例类型vCPU使用量 / 可用总量 ≥ 0 % 不涉及 CloudPond云主机资源 5分钟 mem_used_perflavor 云主机-单实例类型内存使用量 该指标为单实例类型内存使用量。 ≥ 0 GiB 不涉及 CloudPond云主机资源 5分钟 mem_total_perflavor 云主机-单实例类型内存总量 该指标为单实例类型内存总量。 ≥ 0 GiB 不涉及 CloudPond云主机资源 5分钟 mem_util_perflavor 云主机-单实例类型内存利用率 该指标为单实例类型内存使用率。 计算公式：云主机-单实例类型内存使用量 / 可用总量 ≥ 0 % 不涉及 CloudPond云主机资源 5分钟 capacity_used_perblockstor 云硬盘-存储资源使用量 该指标为单存储类型的使用量。 ≥ 0 GiB 不涉及 CloudPond存储资源 5分钟 capacity_total_perblockstor 云硬盘-存储资源可用总量 该指标为单存储类型的总量。 ≥ 0 GiB 不涉及 CloudPond存储资源 5分钟 capacity_util_perblockstor 云硬盘-存储资源使用率 该指标为单存储类型的使用率。 计算公式：云硬盘-存储资源使用量 / 可用总量 ≥ 0 % 不涉及 CloudPond存储资源 5分钟

响应示例 状态码：201 Created { "assigned_user" : { "id" : "ID", "name" : "名称" }, "execute_count" : 4, "extend_info" : { "author" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" }, "defect_list" : [ { "id" : "ID", "name" : "名称" } ], "description" : "描述信息", "domain" : { "id" : "ID", "name" : "名称" }, "fixed_version" : { "id" : "ID", "name" : "名称" }, "issue" : { "id" : "ID", "name" : "名称" }, "label_list" : [ { "id" : "ID", "name" : "名称" } ], "module" : { "id" : "ID", "name" : "名称" }, "preparation" : "前置条件", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "97b82412f1", "updator" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" } }, "name" : "某个测试用例", "project_id" : "2394921", "rank_id" : "2", "result_id" : "0", "service_id" : 13, "status_id" : "1", "testcase_id" : "97b82412f1ca4628803b918c27ed09de", "testcase_number" : "1234" }

请求示例 创建自定义测试服务类型用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases { "extend_info" : { "assigned_id" : "1111", "description" : "这是一段用例描述信息", "fix_version_id" : "11111", "issue_id" : "11111", "label_list" : [ "标签名称" ], "module_id" : "模块号", "preparation" : "需要满足的前置条件", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "11111" }, "name" : "testcase", "rank_id" : "2", "service_id" : 13, "testcase_number" : "1234" }

响应参数 状态码：201 表6 响应Body参数 参数 参数类型 描述 assigned_user AssignedUserInfo object 参数解释: 处理者信息 取值范围: 不涉及 execute_count Integer 参数解释: 测试用例执行次数 取值范围: 不涉及 extend_info ExtendInfo object 参数解释: 测试用例扩展信息 取值范围: 不涉及 name String 参数解释: 测试用例名称 取值范围: 不涉及 project_id String 参数解释: 软开云项目唯一标识 取值范围: 不涉及 rank_id String 参数解释: 测试用例等级 取值范围: 0|1|2|3|4 result_id String 参数解释: 测试用例执行结果 取值范围: 不涉及 service_id Integer 参数解释: 注册测试类型服务接口返回的服务id 取值范围: 不涉及 status_id String 参数解释: 测试用例状态 取值范围: 不涉及 testcase_id String 参数解释: 用例uri,测试用例唯一标识 取值范围: 11-34位字符（字母和数字） testcase_number String 参数解释: 测试用例编号 取值范围: 不涉及 表7 ExtendInfo 参数 参数类型 描述 author ExtendAuthorInfo object 参数解释: 创建者信息 取值范围: 不涉及 defect_list Array of AssignedUserInfo objects 参数解释: 缺陷信息 取值范围: 不涉及 description String 参数解释: 描述信息 取值范围: 不涉及 domain AssignedUserInfo object 参数解释: 租户信息 取值范围: 不涉及 fixed_version AssignedUserInfo object 参数解释: 迭代信息 取值范围: 不涉及 issue AssignedUserInfo object 参数解释: 需求信息 取值范围: 不涉及 label_list Array of AssignedUserInfo objects 参数解释: 标签信息 取值范围: 不涉及 module AssignedUserInfo object 参数解释: 模块信息 取值范围: 不涉及 preparation String 参数解释: 前置条件 取值范围: 不涉及 steps Array of ExternalServiceCaseStep objects 参数解释: 测试步骤 取值范围: 数组长度小于10 test_version_id String 参数解释: 测试版本号 取值范围: 不涉及 updator ExtendAuthorInfo object 参数解释: 更新者信息 取值范围: 不涉及 表8 AssignedUserInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 表9 ExternalServiceCaseStep 参数 参数类型 描述 expect_result String 参数解释: 测试用例预期结果信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 test_step String 参数解释: 测试步骤描述信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 表10 ExtendAuthorInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 time String 参数解释: 时间信息 取值范围: 不涉及 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 extend_info 否 ExternalServiceCaseInfo object 参数解释: 测试用例其他扩展信息}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 name 是 String 参数解释: 页面上显示的用例名称 约束限制: 不涉及 取值范围: 3-128位字符 默认取值: 不涉及 rank_id 否 String 参数解释: 测试用例等级 约束限制: 不涉及 取值范围: 0,1,2,3,4 默认取值: 2 service_id 是 Integer 参数解释: 服务id,该值由注册接口返回 约束限制: 不涉及 取值范围: 10-9999 默认取值: 2 testcase_number 否 String 参数解释: 用例编号 约束限制: 不涉及 取值范围: 3-128位字符 默认取值: 不填该值时会自动生成 表4 ExternalServiceCaseInfo 参数 是否必选 参数类型 描述 assigned_id 否 String 参数解释: 处理者id信息 约束限制: 不涉及 取值范围: 0-32 默认取值: 不涉及 description 否 String 参数解释: 处理者id信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 fix_version_id 否 String 参数解释: 迭代号 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 issue_id 否 String 参数解释: 用例关联的需求id信息 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 label_list 否 Array of strings 参数解释: 标签名称列表 约束限制: 单个名称长度不超过25 取值范围: 小于等于30 默认取值: 不涉及 module_id 否 String 参数解释: 模块号 约束限制: 不涉及 取值范围: 0-32 默认取值: 不涉及 preparation 否 String 参数解释: 执行该测试用例时需要满足的前置条件 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 steps 否 Array of ExternalServiceCaseStep objects 参数解释: 测试步骤 约束限制: 不涉及 取值范围: 数组长度小于10 默认取值: 不涉及 test_version_id 否 String 参数解释: 测试版本号 约束限制: 不涉及 取值范围: 1-64 默认取值: 不涉及 表5 ExternalServiceCaseStep 参数 是否必选 参数类型 描述 expect_result 否 String 参数解释: 测试用例预期结果信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 test_step 否 String 参数解释: 测试步骤描述信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及

URI POST /v1/projects/{project_id}/testcases 表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 ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表4 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表5 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason 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 表2 响应Body参数 参数 参数类型 描述 services Array of ServicesInfo objects 参数解释: 注册服务信息 取值范围: 不涉及 表3 ServicesInfo 参数 参数类型 描述 id Integer 参数解释: 服务id 取值范围: 不涉及 name String 参数解释: 服务名称 取值范围: 不涉及 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

响应参数 状态码：201 表3 响应Body参数 参数 参数类型 描述 service_id Integer 参数解释 接口调用成功返回的服务id 取值范围 不涉及 service_name String 参数解释 接口调用成功返回的服务名 取值范围 不涉及 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 主账号用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 server_host 是 String 参数解释: server_host是由用户提供的 域名 。我们会通过此域名进行接口调用，测试计划将会通过此域名下的接口，保证服务数据与用户系统数据的一致性。 约束限制: 不涉及 取值范围: 以https/http开头 长度小于等于128位字符。 默认取值: 不涉及 service_name 是 String 参数解释: 测试类型名称，用于界面显示，不能使用当前已有测试类型名称，长度小于等于128。 约束限制: 不涉及 取值范围: 长度小于等于128。 默认取值: 不涉及

请求示例 查询时段内用例的执行情况 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 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 参数解释: 起始偏移量,表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 0-20000 默认取值: 不涉及 limit 是 Integer 参数解释: 每页显示的条目数量 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_start_time 是 String 参数解释: 用例执行时间段开始 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_end_time 是 String 参数解释: 用例执行时间段截止 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 success|error result ResultValueStringForOk object 请求结果 表5 ResultValueStringForOk 参数 参数类型 描述 value String 参数解释 ok 取值范围 不涉及 状态码：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 参数解释: 业务失败的提示内容 取值范围: 不涉及

URI DELETE /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 Query参数 参数 是否必选 参数类型 描述 version_uri 否 String 分支或者测试计划uri

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

请求示例 批量删除自定义测试服务类型用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/batch-delete { "service_id" : 13, "testcase_id_list" : [ "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de" ] }

响应参数 状态码：204 No Content 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 是 Integer 参数解释: 测试用例类型ID，指定指定对应类型的测试用例ID 约束限制: 需要与testcase_id_list中提供的用例的执行方式一致 取值范围: 大于0整数 默认取值: 不涉及 testcase_id_list 是 Array of strings 参数解释: 用例uri数组,测试用例唯一标识，测试用例详情页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&case_id={case_id}&detail=base中case_id变量的值 约束限制: 数组小于50个 取值范围: uri长度11-34位字符（字母和数字）,数组小于50个 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListLabelVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListLabelVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of LabelVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 LabelVo 参数 参数类型 描述 uri String uri主键 region String 逻辑region label_name String 标签名称 service_type String 服务类型 resource_type String 所属资源类型（TestCase：用例，Task：测试套） project_uuid String 项目ID 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : [ { "uri" : "v91j0000vpmr57j9", "region" : "cn-north-7", "label_name" : "对对对对对对多", "resource_type" : "TestCase" }, { "uri" : "v91j0vpmr57j939o", "region" : "cn-north-7", "label_name" : "咕咕咕咕咕咕过过过过", "resource_type" : "TestCase" } ] } }

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

响应示例 状态码：500 Internal Server Error { "error_code" : "CLOUDTEST.00000001", "error_msg" : "接口调用失败错误信息", "error_detail" : { "failed" : [ { "error_code" : "CLOUDTEST.00000001", "error_msg" : "返回的错误信息", "testcase_id" : "efdb403066474ab08836b9eeaaa23bca" } ] } }

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "create_count" : 0, "design_count" : 1, "execute_count" : 0, "report_count" : 0, "total_count" : 1 } } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueIteratorStageSummaryVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表6 ResultValueIteratorStageSummaryVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value IteratorStageSummaryVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 IteratorStageSummaryVo 参数 参数类型 描述 create_count Integer 新建状态数量 design_count Integer 设计状态数量 execute_count Integer 执行状态数量 report_count Integer 报告状态数量 total_count Integer 迭代计划总数 表8 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueAccessInfoVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表3 ResultValueAccessInfoVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value AccessInfoVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 AccessInfoVo 参数 参数类型 描述 message String 租户服务开通提示信息 domain_order_status String 租户订单状态 has_free_quota Boolean 是否有免费配额 表5 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 新增测试套任务 post https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/tasks { "name" : "testsuite01", "service_type" : 0, "number" : "", "description" : "", "case_operation_info" : { "set_up_cases_info" : [ ], "tear_down_cases_info" : [ ], "test_cases_info" : [ ] }, "tags" : [ ], "module_id" : "", "module_name" : "", "execute_way" : 1, "ext_param" : "{}", "release_dev" : "", "version_uri" : "v91j0000vldleodb", "plan_start_timestamp" : null, "plan_end_timestamp" : null }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 status String 参数解释: 本次请求的处理状态 取值范围: success|error result ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表8 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表9 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及