华为云用户手册

响应示例 状态码：200 success { "code" : "SV CS TG.CPTS.0000000", "message" : "success", "taskInfo" : { "bench_concurrent" : 100, "case_list" : [ { "case_id" : 211751, "case_type" : 0, "contents" : [ { "content_id" : 0, "content" : [ { "content_type" : 2, "content" : { "body_type" : 0, "bodys" : [ ], "check_end_length" : null, "check_end_str" : null, "check_end_type" : null, "connect_timeout" : 5000, "connect_type" : 1, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "http_version" : "HTTP/1.1", "method" : "GET", "name" : "Msg-43147", "protocol_type" : 1, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "https://www.example.com" } } ], "index" : 0, "selected_temp_name" : "", "data" : null, "data_type" : 0, "conditions" : null } ], "for_loop_params" : [ ], "increase_setting" : [ ], "sort" : 1, "stages" : [ ], "status" : 1, "temp_id" : 0, "user_replicas" : 0 }, { "case_id" : 213142, "case_type" : 0, "contents" : null, "for_loop_params" : [ ], "increase_setting" : [ ], "sort" : 2, "stages" : [ ], "status" : 1, "temp_id" : 0, "user_replicas" : 0 } ], "create_time" : "2022-01-18T15:20:50.466972+08:00", "description" : "", "name" : "task", "operate_mode" : 2, "parallel" : false, "project_id" : 122025, "related_temp_running_data" : [ ], "run_status" : 2, "update_time" : "2022-01-20T15:00:44.284053+08:00" } }

请求示例 修改id为1的任务，任务名字修改为taskName。 /v1/{project_id}/tasks/1 { "id" : 1, "name" : "taskName", "description" : "", "project_id" : 1, "run_status" : 2, "run_type" : 0, "task_run_info" : { "id" : 0, "run_type" : 0 }, "case_list" : [ ], "operate_mode" : 2, "bench_concurrent" : 100, "related_temp_running_data" : [ { "task_run_info_id" : 325, "related_temp_running_id" : 350, "temp_id" : 0, "temp_name" : "asdf" } ] }

响应参数 状态码：200 表16 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 taskInfo TaskInfo object 任务详情 表17 TaskInfo 参数 参数类型 描述 bench_concurrent Integer 基准并发 case_list Array of CaseInfoDetail objects 用例ID列表 create_time String 创建时间 description String 描述信息 name String 任务名称 operate_mode Integer 任务模式（0：时长模式；1：次数模式；2：混合模式） project_id Integer 任务所属工程ID related_temp_running_data Array of RelatedTempRunningData objects 最近一次运行的报告简略信息，包括运行任务ID，即本对象的task_run_info_id。运行用例ID，即本对象的related_temp_running_id。 run_status Integer 任务运行状态（9：等待运行；0：运行中；1：暂停；2：结束； 3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止） update_time String 任务更新时间 parallel Boolean 任务间用例是否并行执行 表18 CaseInfoDetail 参数 参数类型 描述 case_id Integer 用例ID name String 用例名称 case_type Integer 用例类型（0：常规用例；） contents Array of Contents objects 用例脚本信息 for_loop_params Array of objects 旧版本逻辑控制器字段，当前已未使用 increase_setting Array of objects 梯度递增 stages Array of TestCaseStage objects 阶段信息 status Integer 状态，0：已删除；1：启用；2：禁用 temp_id Integer 用例ID sort Integer 排序字段 directory_id Integer 用例所属目录ID（旧版接口可不传） setup_contents Array of Contents objects 前置步骤 user_replicas Integer 执行器个数 collect_log_policy Integer 日志采集策略（0-请求模式；1-用例模式） link_app_list Array of integers 关联全链路应用列表 case_info CaseDoc object 文本用例信息 表19 TestCaseStage 参数 参数类型 描述 operate_mode Integer 压力阶段模式，0：时长模式；1：次数模式 name String 阶段名称 time Integer 压测时长（单位：秒） start_time Integer 开始时间 end_time Integer 结束时间 issue_num Integer 最大并发数 count Integer 次数模式发送总次数 pressure_mode Integer 压力模式，0：并发模式；1：TPS模式；2：摸高模式；3：浪涌并发模式；4：浪涌TPS模式；5：震荡并发模式；6：震荡TPS模式；7：智能摸高模式 tps_value Integer TPS模式下TPS值 current_user_num Integer 起始并发数 current_tps Integer 起始TPS值 voltage_regulating_mode Integer 调压模式，0：自动调压模式；1：手动调压模式 maximum Integer 浪涌/浪涌模式下最大并发数 minimum Integer 浪涌/浪涌模式下最小并发数 loop_count Integer 震荡/浪涌次数 max_duration Integer 浪涌模式下峰值持续时间 ramp_up Integer 摸高模式下爬坡时长（单位：秒） peak_load_kpis StageKpiItems object 摸高指标 step_duration Integer 智能摸高模式下单步执行时长 step_size Integer 智能摸高模式下递增并发数 表20 StageKpiItems 参数 参数类型 描述 average_response_time StageKpiItem object 平均响应时间 success_rate StageKpiItem object 成功率 表21 StageKpiItem 参数 参数类型 描述 comparison String 比较符 value Integer 比较值 表22 Contents 参数 参数类型 描述 content_id Integer 事务ID，若不为0表示此卡片为事务；为0表示非事务 content Array of Content objects 内容 index Integer 排序索引标识 selected_temp_name String 选择的事务或者用例名称 data Object 数据（循环、条件控制器作用的数据） data_type Integer 数据指令类型（0：默认请求卡片；1：数据指令；201：循环指令；202：条件指令；301：集合点；203：vu百分比控制器；204：吞吐量控制器；302：插件请求） conditions Object 若类型为202：条件指令，该字段为条件配置 is_disabled Boolean 是否禁用 表23 Content 参数 参数类型 描述 content_type Integer 用例卡片类型（1：思考时间；2：报文；3：检查点；4：变量提取） content ContentInfo object 内容 表24 ContentInfo 参数 参数类型 描述 body_type Integer body类型（0：字符串；1：form-data格式；3：x-www-form-urlencoded格式） bodys Array of objects 请求体 check_end_length Object TCP/UDP协议返回数据长度 check_end_str Object TCP/UDP协议返回结束符 check_end_type Object TCP/UDP协议返回结束类型，1：返回数据长度；2：结束符 connect_timeout Integer 超时时间 connect_type Integer 连接设置，当前版本已未使用 headers Array of ContentHeader objects 请求头 http_version String HTTP版本 method String HTTP方法 name String 用例名称 protocol_type Integer 协议类型（1：HTTP；2：HTTPS；3：TCP；4：UDP；7：HLS/RTMP；9：WebSocket；10：HTTP-FLV；11：MQTT） return_timeout Integer 响应超时 return_timeout_param String 响应超时参数 url String 请求地址 rtmp_url String rtmp地址 flv_url String flv地址 bitrate_type Integer 分辨率策略 duration Integer 持续时间 retry_delay Integer HLS重试延迟时间 retry_time Integer HLS重试次数 表25 ContentHeader 参数 参数类型 描述 key String 键 value String 值 表26 CaseDoc 参数 参数类型 描述 description String 用例描述信息 label_names Array of strings 标签 preparation String 前置条件 rank Integer 用例等级（0-L0；1-L1；2-L2；3-L3；4-L4；） status_code Integer 状态（0-新建；5-设计中；6-测试中；7-完成；） steps Array of steps objects 测试步骤 表27 steps 参数 参数类型 描述 expect_result String 步骤描述 test_step String 预期结果 表28 RelatedTempRunningData 参数 参数类型 描述 task_run_info_id Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 related_temp_running_id Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 temp_id Integer 用例ID temp_name String 用例名称 content_method_url Array of strings 请求信息，包括请求名称、方法、URL信息 related_temp_running_data Array of TempRunningData objects 最近一次运行的报告简略信息 表29 TempRunningData 参数 参数类型 描述 content_method_url Array of strings 请求信息，包括请求名称，方法，url信息 crawler_status Integer 请求运行状态（0：正常返回；1：解析失败； 2：比对失败； 3：响应超时；） related_temp_running_id Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 task_run_info_id Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 temp_id Integer 用例或者事务ID temp_name String 用例或者事务名称 temp_running_status Integer 运行状态（9：表示等待运行；0：表示运行中；2：表示结束；3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止（终止中状态）） 状态码：501 表30 响应Body参数 参数 参数类型 描述 - String response message

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 Integer 任务ID name 是 String 任务名称 description 否 String 描述 project_id 是 Integer 工程ID run_status 否 Integer 任务运行状态（9：等待运行；0：运行中；1：暂停；2：结束； 3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止） run_type 否 Integer 任务类型（0：旧版本任务；1：新版本任务） task_run_info 否 TaskRunInfo object 任务运行信息 case_list 否 Array of CaseInfoDetail objects 用例信息 operate_mode 否 Integer 压力阶段模式，0：时长模式；1：次数模式 bench_concurrent 否 Integer 基准并发 related_temp_running_data 否 Array of RelatedTempRunningData objects 最近一次运行的报告简略信息 表3 TaskRunInfo 参数 是否必选 参数类型 描述 id 否 Integer 任务ID run_type 否 Integer 任务类型（0：旧版本任务；1：新版本任务） 表4 CaseInfoDetail 参数 是否必选 参数类型 描述 case_id 否 Integer 用例ID name 否 String 用例名称 case_type 否 Integer 用例类型（0：常规用例；） contents 否 Array of Contents objects 用例脚本信息 for_loop_params 否 Array of objects 旧版本逻辑控制器字段，当前已未使用 increase_setting 否 Array of objects 梯度递增 stages 否 Array of TestCaseStage objects 阶段信息 status 否 Integer 状态，0：已删除；1：启用；2：禁用 temp_id 否 Integer 用例ID sort 否 Integer 排序字段 directory_id 否 Integer 用例所属目录ID（旧版接口可不传） setup_contents 否 Array of Contents objects 前置步骤 user_replicas 否 Integer 执行器个数 collect_log_policy 否 Integer 日志采集策略（0-请求模式；1-用例模式） link_app_list 否 Array of integers 关联全链路应用列表 case_info 否 CaseDoc object 文本用例信息 表5 TestCaseStage 参数 是否必选 参数类型 描述 operate_mode 否 Integer 压力阶段模式，0：时长模式；1：次数模式 name 否 String 阶段名称 time 否 Integer 压测时长（单位：秒） start_time 否 Integer 开始时间 end_time 否 Integer 结束时间 issue_num 否 Integer 最大并发数 count 否 Integer 次数模式发送总次数 pressure_mode 否 Integer 压力模式，0：并发模式；1：TPS模式；2：摸高模式；3：浪涌并发模式；4：浪涌TPS模式；5：震荡并发模式；6：震荡TPS模式；7：智能摸高模式 tps_value 否 Integer TPS模式下TPS值 current_user_num 否 Integer 起始并发数 current_tps 否 Integer 起始TPS值 voltage_regulating_mode 否 Integer 调压模式，0：自动调压模式；1：手动调压模式 maximum 否 Integer 浪涌/浪涌模式下最大并发数 minimum 否 Integer 浪涌/浪涌模式下最小并发数 loop_count 否 Integer 震荡/浪涌次数 max_duration 否 Integer 浪涌模式下峰值持续时间 ramp_up 否 Integer 摸高模式下爬坡时长（单位：秒） peak_load_kpis 否 StageKpiItems object 摸高指标 step_duration 否 Integer 智能摸高模式下单步执行时长 step_size 否 Integer 智能摸高模式下递增并发数 表6 StageKpiItems 参数 是否必选 参数类型 描述 average_response_time 否 StageKpiItem object 平均响应时间 success_rate 否 StageKpiItem object 成功率 表7 StageKpiItem 参数 是否必选 参数类型 描述 comparison 否 String 比较符 value 否 Integer 比较值 表8 Contents 参数 是否必选 参数类型 描述 content_id 否 Integer 事务ID，若不为0表示此卡片为事务；为0表示非事务 content 否 Array of Content objects 内容 index 否 Integer 排序索引标识 selected_temp_name 否 String 选择的事务或者用例名称 data 否 Object 数据（循环、条件控制器作用的数据） data_type 否 Integer 数据指令类型（0：默认请求卡片；1：数据指令；201：循环指令；202：条件指令；301：集合点；203：vu百分比控制器；204：吞吐量控制器；302：插件请求） conditions 否 Object 若类型为202：条件指令，该字段为条件配置 is_disabled 否 Boolean 是否禁用 表9 Content 参数 是否必选 参数类型 描述 content_type 否 Integer 用例卡片类型（1：思考时间；2：报文；3：检查点；4：变量提取） content 否 ContentInfo object 内容 表10 ContentInfo 参数 是否必选 参数类型 描述 body_type 否 Integer body类型（0：字符串；1：form-data格式；3：x-www-form-urlencoded格式） bodys 否 Array of objects 请求体 check_end_length 否 Object TCP/UDP协议返回数据长度 check_end_str 否 Object TCP/UDP协议返回结束符 check_end_type 否 Object TCP/UDP协议返回结束类型，1：返回数据长度；2：结束符 connect_timeout 否 Integer 超时时间 connect_type 否 Integer 连接设置，当前版本已未使用 headers 否 Array of ContentHeader objects 请求头 http_version 否 String HTTP版本 method 否 String HTTP方法 name 否 String 用例名称 protocol_type 否 Integer 协议类型（1：HTTP；2：HTTPS；3：TCP；4：UDP；7：HLS/RTMP；9：WebSocket；10：HTTP-FLV；11：MQTT） return_timeout 否 Integer 响应超时 return_timeout_param 否 String 响应超时参数 url 否 String 请求地址 rtmp_url 否 String rtmp地址 flv_url 否 String flv地址 bitrate_type 否 Integer 分辨率策略 duration 否 Integer 持续时间 retry_delay 否 Integer HLS重试延迟时间 retry_time 否 Integer HLS重试次数 表11 ContentHeader 参数 是否必选 参数类型 描述 key 否 String 键 value 否 String 值 表12 CaseDoc 参数 是否必选 参数类型 描述 description 否 String 用例描述信息 label_names 否 Array of strings 标签 preparation 否 String 前置条件 rank 否 Integer 用例等级（0-L0；1-L1；2-L2；3-L3；4-L4；） status_code 否 Integer 状态（0-新建；5-设计中；6-测试中；7-完成；） steps 否 Array of steps objects 测试步骤 表13 steps 参数 是否必选 参数类型 描述 expect_result 否 String 步骤描述 test_step 否 String 预期结果 表14 RelatedTempRunningData 参数 是否必选 参数类型 描述 task_run_info_id 否 Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 related_temp_running_id 否 Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 temp_id 否 Integer 用例ID temp_name 否 String 用例名称 content_method_url 否 Array of strings 请求信息，包括请求名称、方法、URL信息 related_temp_running_data 否 Array of TempRunningData objects 最近一次运行的报告简略信息 表15 TempRunningData 参数 是否必选 参数类型 描述 content_method_url 否 Array of strings 请求信息，包括请求名称，方法，url信息 crawler_status 否 Integer 请求运行状态（0：正常返回；1：解析失败； 2：比对失败； 3：响应超时；） related_temp_running_id 否 Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 task_run_info_id 否 Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 temp_id 否 Integer 用例或者事务ID temp_name 否 String 用例或者事务名称 temp_running_status 否 Integer 运行状态（9：表示等待运行；0：表示运行中；2：表示结束；3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止（终止中状态））

响应示例 状态码：200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "variable_list" : [ { "file_size" : 0, "id" : 37615, "is_quoted" : false, "name" : "var1", "share_mode" : 0, "variable" : [ 1, 20 ], "variable_mode" : 0, "variable_type" : 1 }, { "file_size" : 0, "id" : 36306, "is_quoted" : true, "name" : "var2", "share_mode" : 0, "variable" : [ "domain-example.com" ], "variable_mode" : 0, "variable_type" : 2 } ] }

请求示例 查询PerfTest工程的变量列表。 /v1/{project_id}/variables/{variable_type}/test-suites/1 { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "variable_list" : [ { "file_size" : 0, "id" : 156769, "is_quoted" : false, "is_sensitive" : false, "name" : "var1", "share_mode" : 0, "variable" : [ "test" ], "variable_mode" : 0, "variable_type" : 2 } ] }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 variable_list Array of VariableDetail objects 变量列表 表3 VariableDetail 参数 参数类型 描述 file_size Integer 文件大小 id Integer 变量ID is_quoted Boolean 是否被引用 name String 变量名称 variable Array of objects 变量值 variable_type Integer 变量类型（1：整数；2：枚举；3：文件；5：文本） variable_mode Integer 变量读取模式，0：顺序模式；1：随机模式 share_mode Integer 变量共享模式，0：用例模式；1：并发模式 状态码：501 表4 响应Body参数 参数 参数类型 描述 - String response message

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 test_cases Array of TestCaseBriefInfo objects 用例列表 表3 TestCaseBriefInfo 参数 参数类型 描述 id Integer 用例ID name String 用例名称 status Integer 状态（0-已删除；1-启用；2-停用；） create_time String 创建时间 update_time String 更新时间 parent_id Integer 所属目录ID type Integer 类型（1-目录；2-用例；）

请求示例 修改一个任务，任务ID是1，任务名修改为task，任务关联的用例ID集合为16674，16675。 /v3/{project_id}/tasks/1 { "name" : "task", "parallel" : false, "project_id" : 17543, "operate_mode" : 2, "case_id_list" : [ 16674, 16675 ] }

响应示例 状态码：200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "taskInfo" : { "bench_concurrent" : 100, "case_list" : [ { "case_id" : 211751, "case_type" : 0, "contents" : [ { "content_id" : 0, "content" : [ { "content_type" : 2, "content" : { "body_type" : 0, "bodys" : [ ], "check_end_length" : null, "check_end_str" : null, "check_end_type" : null, "connect_timeout" : 5000, "connect_type" : 1, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "http_version" : "HTTP/1.1", "method" : "GET", "name" : "Msg-43147", "protocol_type" : 1, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "https://www.example.com" } } ], "index" : 0, "selected_temp_name" : "", "data" : null, "data_type" : 0, "conditions" : null } ], "for_loop_params" : [ ], "increase_setting" : [ ], "sort" : 1, "stages" : [ ], "status" : 1, "temp_id" : 0, "user_replicas" : 0 }, { "case_id" : 213142, "case_type" : 0, "contents" : null, "for_loop_params" : [ ], "increase_setting" : [ ], "sort" : 2, "stages" : [ ], "status" : 1, "temp_id" : 0, "user_replicas" : 0 } ], "create_time" : "2022-01-18T15:20:50.466972+08:00", "description" : "", "name" : "task", "operate_mode" : 2, "parallel" : false, "project_id" : 122025, "related_temp_running_data" : [ ], "run_status" : 2, "update_time" : "2022-01-20T15:00:44.284053+08:00" } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 taskInfo TaskInfo object 任务详情 表4 TaskInfo 参数 参数类型 描述 bench_concurrent Integer 基准并发 case_list Array of CaseInfoDetail objects 用例ID列表 create_time String 创建时间 description String 描述信息 name String 任务名称 operate_mode Integer 任务模式（0：时长模式；1：次数模式；2：混合模式） project_id Integer 任务所属工程ID related_temp_running_data Array of RelatedTempRunningData objects 最近一次运行的报告简略信息，包括运行任务ID，即本对象的task_run_info_id。运行用例ID，即本对象的related_temp_running_id。 run_status Integer 任务运行状态（9：等待运行；0：运行中；1：暂停；2：结束； 3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止） update_time String 任务更新时间 parallel Boolean 任务间用例是否并行执行 表5 CaseInfoDetail 参数 参数类型 描述 case_id Integer 用例ID name String 用例名称 case_type Integer 用例类型（0：常规用例；） contents Array of Contents objects 用例脚本信息 for_loop_params Array of objects 旧版本逻辑控制器字段，当前已未使用 increase_setting Array of objects 梯度递增 stages Array of TestCaseStage objects 阶段信息 status Integer 状态，0：已删除；1：启用；2：禁用 temp_id Integer 用例ID sort Integer 排序字段 directory_id Integer 用例所属目录ID（旧版接口可不传） setup_contents Array of Contents objects 前置步骤 user_replicas Integer 执行器个数 collect_log_policy Integer 日志采集策略（0-请求模式；1-用例模式） link_app_list Array of integers 关联全链路应用列表 case_info CaseDoc object 文本用例信息 表6 TestCaseStage 参数 参数类型 描述 operate_mode Integer 压力阶段模式，0：时长模式；1：次数模式 name String 阶段名称 time Integer 压测时长（单位：秒） start_time Integer 开始时间 end_time Integer 结束时间 issue_num Integer 最大并发数 count Integer 次数模式发送总次数 pressure_mode Integer 压力模式，0：并发模式；1：TPS模式；2：摸高模式；3：浪涌并发模式；4：浪涌TPS模式；5：震荡并发模式；6：震荡TPS模式；7：智能摸高模式 tps_value Integer TPS模式下TPS值 current_user_num Integer 起始并发数 current_tps Integer 起始TPS值 voltage_regulating_mode Integer 调压模式，0：自动调压模式；1：手动调压模式 maximum Integer 浪涌/浪涌模式下最大并发数 minimum Integer 浪涌/浪涌模式下最小并发数 loop_count Integer 震荡/浪涌次数 max_duration Integer 浪涌模式下峰值持续时间 ramp_up Integer 摸高模式下爬坡时长（单位：秒） peak_load_kpis StageKpiItems object 摸高指标 step_duration Integer 智能摸高模式下单步执行时长 step_size Integer 智能摸高模式下递增并发数 表7 StageKpiItems 参数 参数类型 描述 average_response_time StageKpiItem object 平均响应时间 success_rate StageKpiItem object 成功率 表8 StageKpiItem 参数 参数类型 描述 comparison String 比较符 value Integer 比较值 表9 Contents 参数 参数类型 描述 content_id Integer 事务ID，若不为0表示此卡片为事务；为0表示非事务 content Array of Content objects 内容 index Integer 排序索引标识 selected_temp_name String 选择的事务或者用例名称 data Object 数据（循环、条件控制器作用的数据） data_type Integer 数据指令类型（0：默认请求卡片；1：数据指令；201：循环指令；202：条件指令；301：集合点；203：vu百分比控制器；204：吞吐量控制器；302：插件请求） conditions Object 若类型为202：条件指令，该字段为条件配置 is_disabled Boolean 是否禁用 表10 Content 参数 参数类型 描述 content_type Integer 用例卡片类型（1：思考时间；2：报文；3：检查点；4：变量提取） content ContentInfo object 内容 表11 ContentInfo 参数 参数类型 描述 body_type Integer body类型（0：字符串；1：form-data格式；3：x-www-form-urlencoded格式） bodys Array of objects 请求体 check_end_length Object TCP/UDP协议返回数据长度 check_end_str Object TCP/UDP协议返回结束符 check_end_type Object TCP/UDP协议返回结束类型，1：返回数据长度；2：结束符 connect_timeout Integer 超时时间 connect_type Integer 连接设置，当前版本已未使用 headers Array of ContentHeader objects 请求头 http_version String HTTP版本 method String HTTP方法 name String 用例名称 protocol_type Integer 协议类型（1：HTTP；2：HTTPS；3：TCP；4：UDP；7：HLS/RTMP；9：WebSocket；10：HTTP-FLV；11：MQTT） return_timeout Integer 响应超时 return_timeout_param String 响应超时参数 url String 请求地址 rtmp_url String rtmp地址 flv_url String flv地址 bitrate_type Integer 分辨率策略 duration Integer 持续时间 retry_delay Integer HLS重试延迟时间 retry_time Integer HLS重试次数 表12 ContentHeader 参数 参数类型 描述 key String 键 value String 值 表13 CaseDoc 参数 参数类型 描述 description String 用例描述信息 label_names Array of strings 标签 preparation String 前置条件 rank Integer 用例等级（0-L0；1-L1；2-L2；3-L3；4-L4；） status_code Integer 状态（0-新建；5-设计中；6-测试中；7-完成；） steps Array of steps objects 测试步骤 表14 steps 参数 参数类型 描述 expect_result String 步骤描述 test_step String 预期结果 表15 RelatedTempRunningData 参数 参数类型 描述 task_run_info_id Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 related_temp_running_id Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 temp_id Integer 用例ID temp_name String 用例名称 content_method_url Array of strings 请求信息，包括请求名称、方法、URL信息 related_temp_running_data Array of TempRunningData objects 最近一次运行的报告简略信息 表16 TempRunningData 参数 参数类型 描述 content_method_url Array of strings 请求信息，包括请求名称，方法，url信息 crawler_status Integer 请求运行状态（0：正常返回；1：解析失败； 2：比对失败； 3：响应超时；） related_temp_running_id Integer 运行用例ID。对应其他（如报告）接口的运行用例ID（case_run_id）。 task_run_info_id Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 temp_id Integer 用例或者事务ID temp_name String 用例或者事务名称 temp_running_status Integer 运行状态（9：表示等待运行；0：表示运行中；2：表示结束；3：异常中止；4：用户主动终止（完成状态）；5：用户主动终止（终止中状态）） 状态码：501 表17 响应Body参数 参数 参数类型 描述 - String response message

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 名称 parallel 是 Boolean 并行状态（表示任务执行时用例是否并行执行；true：并行执行，false：串行执行） project_id 是 Integer 工程ID operate_mode 是 Integer 任务模式（兼容旧版接口保留字段，0：时长模式，1：次数模式，2：混合模式；此处请传固定值：2） case_id_list 是 Array of integers 关联的用例ID集合

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.example.com/v3/auth/tokens

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxx为project的ID，获取方法请参见获取项目ID。 POST https://iam.example.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 type 否 Integer 类型（0-旧版本任务；1-新版本任务） project_id 是 Integer 所属工程ID task_id_list 是 Array of integers 任务ID列表 cluster_id 是 Integer 资源组ID cluster_type 是 String 资源组类型（共享资源组：shared-cluster-internet；私有资源组：private-cluster） without_package 否 Integer 套餐包VUM不足的情况下用户选择是不是要走按需计费模式（当前版本固定值：0） network_info 否 NetworkInfo object 网络信息 status 是 Integer 状态（9：启动任务；2：停止任务） enterprise_project_id 否 String 企业项目ID 表3 NetworkInfo 参数 是否必选 参数类型 描述 network_type 是 String 网络类型（固定值：internet）

请求示例 批量启动任务，使用共享资源组，任务的id集合有1，2。 /v1/{project_id}/test-suites/{test_suit_id}/tasks/batch-update-task-status { "enterprise_project_id" : "0", "type" : 1, "status" : 9, "without_package" : 0, "project_id" : 1, "cluster_id" : 0, "cluster_type" : "shared-cluster-internet", "network_info" : { "network_type" : "internet" }, "task_id_list" : [ 1, 2 ] }

响应参数 状态码：201 表3 响应Body参数 参数 参数类型 描述 code String 响应码 json CreateCaseResultJson object json message String 响应消息 表4 CreateCaseResultJson 参数 参数类型 描述 task_case_id Integer 用例ID 状态码：501 表5 响应Body参数 参数 参数类型 描述 - String response message

调用API获取项目ID 项目ID可以通过调用IAM的查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点管理员处获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xxxxxxxx", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 extend String 扩展信息 result ReportInfo object 数据服务返回的报告数据 表4 ReportInfo 参数 参数类型 描述 brokens ReportbrokensInfo object 曲线数据 details ReportdetailsInfo object 表格数据详情 outline ReportoutlineInfo object 汇总数据 rtproportion String 响应时间分布 taskInfo ReportTaskInfo object 任务信息 respTimeRange Object 响应时间分布 表5 ReportbrokensInfo 参数 参数类型 描述 brand_brokens BrandBrokens object 带宽曲线数据 commonTimestamps Array of strings 时间戳 respcode_brokens RespcodeBrokens object 响应码曲线数据 tps_brokens TpsBrokens object tps、响应时间曲线数据 vusers_brokens VusersBrokens object vusers曲线数据 表6 BrandBrokens 参数 参数类型 描述 recBytes Array of doubles 接收字节数 sentBytes Array of doubles 发送字节数 表7 RespcodeBrokens 参数 参数类型 描述 checkPointFailed Array of doubles 校验失败 error Array of doubles 异常请求 othersFailed Array of doubles 其他失败 parsedFailed Array of doubles 解析失败 refusedFailed Array of doubles 连接被拒 success Array of doubles 成功请求 timeout Array of doubles 超时失败 表8 TpsBrokens 参数 参数类型 描述 average Array of doubles 平均响应时间 tps Array of doubles tps 表9 VusersBrokens 参数 参数类型 描述 vusers Array of doubles 虚拟用户数 表10 ReportdetailsInfo 参数 参数类型 描述 data Array of ReportdetailItemInfo objects 表格数据 pageIndex Integer 页码 pageSize Integer 每页大小 total Integer 总记录数 表11 ReportdetailItemInfo 参数 参数类型 描述 customTransactions Array of strings 自定义事务数据 detailDatas Array of DetailDataInfo objects aw数据 performance PerformanceInfo object 用例数据 表12 DetailDataInfo 参数 参数类型 描述 averageRespTime Double 平均响应时间 avgRecBytes Double 平均接收字节数 avgSentBytes Double 平均发送字节数 avgTranRespTime Double 事务平均响应时间 caseUri String 用例URI createTime String 创建时间 currentThreadNum Double 最大并发数 detailId String 详情ID endTime String 结束时间 errorCount Double 失败请求数 errorEventsCount Double ERROR级别的事件个数 failedAssert Double 断言失败 failedOthers Double 其他失败 failedParsed Double 解析失败 failedRefused Double 连接被拒 failedTimeout Double 超时失败 id String id isAW Boolean 是否aw max Double 最大响应时间 maxRecBytes Double 最大接收字节数 maxRespTime Double 探底最大响应时间 maxSentBytes Double 最大发送字节数 maxTranRespTime Double 事务最大响应时间 min Double 最小响应时间 minNetworkTraffic Double 最小带宽 name String 名字 requests Double 请求数 result Double aw执行结果 startTime String 开始时间 status Double 用例状态 successCount Double 成功请求数 successRate Double 成功率 sum1xx Double 1xx请求数 sum2xx Double 2xx请求数 sum3xx Double 3xx请求数 sum4xx Double 4xx请求数 sum5xx Double 5xx请求数 taskId String 任务ID_轮次 taskProjectId String 任务ID taskStatus Double 任务状态 testCaseUri String 用例URI tp50 Double tp50 tp75 Double tp75 tp90 Double tp90 tp95 Double tp95 tp99 Double tp99 tps Double tps tranTPS Double 事务tps transactionId String 事务ID transactionSuccess Double 事务成功率 transactionalSuccessRate Double 事务成功率 transactionalTps Double 自定义事务tps transactionalTpsSuccess Double 自定义事务成功率 transactions Double 事务数 updateTime String 更新时间 vum Double 分钟*并发数 avgNetworkTraffic Double 平均带宽 maxNetworkTraffic Double 最大带宽 表13 PerformanceInfo 参数 参数类型 描述 averageRespTime Double 平均响应时间 avgNetworkTraffic Double 平均带宽 avgRecBytes Double 平均下行带宽 avgSentBytes Double 平均上行带宽 avgTranRespTime Double 事务平均响应时间 caseUri String 用例URI createTime String 创建时间 currentThreadNum Double 最大并发数 detailId String 详情ID endTime String 结束时间 errorCount Double 失败请求数 errorEventsCount Double ERROR级别的事件个数 failedAssert Double 断言失败 failedOthers Double 其他失败 failedParsed Double 解析失败 failedRefused Double 连接被拒 failedTimeout Double 超时失败 id String id isAW Boolean 是否aw max Double 最大响应时间 maxNetworkTraffic Double 最大带宽 maxRecBytes Double 最大接收字节数 maxRespTime Double 探底结果：响应时间 maxSentBytes Double 最大发送带宽 maxTranRespTime Double 事务最大响应时间 min Double 最小响应时间 minNetworkTraffic Double 最小带宽 name String 名称 requests Double 请求数 result Double 用例/aw的执行结果 startTime String 开始时间 status Double 用例状态 successCount Double 成功数 successRate Double 成功率 sum1xx Double 1xx响应码计数 sum2xx Double 2xx响应码计数 sum3xx Double 3xx响应码计数 sum4xx Double 4xx响应码计数 sum5xx Double 5xx响应码计数 taskId String 任务ID_轮次 taskProjectId String 任务ID taskStatus Double 任务状态 testCaseUri String 用例URI tp50 Double tp50 tp75 Double tp75 tp90 Double tp90 tp95 Double tp95 tp99 Double tp99 tp999 Double tp999 tp9999 Double tp9999 tps Double tps tranTPS Double 事务TPS transactionId String 事务ID transactionSuccess Double 成功事务数 transactionalSuccessRate Double 事务成功率 transactionalTps Double 自定义事务tps transactionalTpsSuccess Double 自定义事务成功率 transactions Double 事务数 updateTime String 更新时间 vum Double 分钟数*并发数 表14 ReportoutlineInfo 参数 参数类型 描述 avgResponseTime Double 平均响应时间 branchId String 分支ID branchName String 分支名称 caseRetry Double 用例重试次数 completeNum Double 已完成的用例数 duration Double 持续时间 endTime String 结束时间 executedNum Double 已执行用例数 iterationUri String 迭代ID kpiCaseCount Double kpi用例数 kpiCaseExecuteCount Double kpi用例执行次数 kpiCasePassCount Double kpi用例通过次数 maxUsers Double 最大并发数 passNum Double 结果为pass的用例数 stage Double 阶段ID stageName String 阶段名称 startTime String 开始时间 successRate Double 成功率 taskStatus Double 任务状态 totalNum Double 总用例数 tps Double 性能tps指标 versionUri String 分支URI projectId String 工程ID serviceId String 服务ID progressState String 内部版本字段，已弃用，待删除 createBy String 报告执行人 statusValue String 内部版本字段，已弃用，待删除 表15 ReportTaskInfo 参数 参数类型 描述 vum Double 分钟*并发数 状态码：501 表16 响应Body参数 参数 参数类型 描述 - String response message

URI GET /v1/{project_id}/task-run-infos/{task_run_id}/case-run-infos/{case_run_id}/reports 表1 路径参数 参数 是否必选 参数类型 描述 task_run_id 是 Integer 运行任务ID，即报告ID。启动任务（更新任务状态或批量启停任务）接口，会返回运行任务ID。 case_run_id 是 Integer 运行用例ID，报告管理中的“当前任务用例列表”接口，使用任务运行id（task_run_id）作为路径参数，可以查询到该报告关联的用例运行id集合，即返回结构体中result.case_aw_info_list[index].case_uri_i为索引为index的运行用例ID（case_run_id）。 project_id 是 String 表示项目ID，参见获取方法说明。 表2 Query参数 参数 是否必选 参数类型 描述 brokens_limit_count 是 Integer 曲线图点数

响应示例 状态码：200 success { "code" : "SVCSTG.CPTS.0000000", "log_list" : [ { "name" : "temp_name_2022-07-20T17:01:57+08:00", "run_id" : 48105, "run_type" : 1, "start_time" : "2022-07-20T17:01:57+08:00", "end_time" : "2022-07-20T17:11:52+08:00", "continue_time" : 595, "temp_names" : [ { "name" : "temp_name" } ], "parallel" : false } ], "message" : "success" }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 log_list Array of HistoryRunInfo objects 报告列表 表3 HistoryRunInfo 参数 参数类型 描述 name String 名称 run_id Double 报告ID run_type Double 任务类型（0：旧版本任务；1：新版本任务） start_time String 开始时间 end_time String 结束时间 continue_time Double 继续时间 temp_names Array of TempName objects 用例或者事务名称 parallel Boolean 任务间用例是否并行执行 表4 TempName 参数 参数类型 描述 name String 名称 状态码：501 表5 响应Body参数 参数 参数类型 描述 - String response message

响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 code String 响应码 json CreateVariableResultJson object 响应json message String 响应消息 表5 CreateVariableResultJson 参数 参数类型 描述 variable_id Integer 变量ID 状态码：501 表6 响应Body参数 参数 参数类型 描述 - String response message

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of UpdateVariableRequestBody objects UpdateVariableRequestBody 表3 UpdateVariableRequestBody 参数 是否必选 参数类型 描述 id 是 Integer 变量ID name 是 String 变量名称 variable_type 是 Integer 变量类型（1：整数；2：枚举；3：文件；5：文本） variable 是 Array of objects 变量值

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 json UploadProcessJson object 响应内容 extend String 扩展信息 表3 UploadProcessJson 参数 参数类型 描述 details Array of UploadProcessJsonDetail objects 工程导入进度明细信息 process_status Integer 总状态（0：导入中；1：导入完成） 表4 UploadProcessJsonDetail 参数 参数类型 描述 id Integer 导入进度ID name String 工程名称 status Integer 导入状态（0：导入中；1：成功；2：失败） cause String 失败原因 状态码：501 表5 响应Body参数 参数 参数类型 描述 - String response message

响应示例 状态码：200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "json" : { "details" : [ { "id" : 0, "name" : "工程名称", "status" : 1, "cause" : "" } ], "process_status" : 1 }, "extend" : null }

请求示例 调试一个用例，用例的id是1，使用共享资源组启动调试。 /v1/projectId/test-suites/testSuiteId/tasks/0/cases/1/debug { "status" : 9, "cluster_id" : 0, "cluster_type" : "shared-cluster-internet", "without_package" : 1 }

响应示例 状态码：200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "extend" : null, "result" : [ { "body" : "", "errorReason" : "", "header" : { "Content-Type" : "application/json", "Host" : "117.xxx.xxx.xxx:xxx" }, "name" : "Msg-84012", "responseTime" : 24, "result" : 1, "returnBody" : "", "returnHeader" : { "Content-Length" : "0", "Content-Type" : "text/plain; charset=utf-8", "Date" : "Mon, 19 Sep 2022 07:29:46 GMT" }, "statusCode" : "200 OK", "url" : "GET https://117.xxx.xxx.xxx:xxx/goserver/reflect" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 extend String 扩展信息 result Array of DebugCaseResult objects 结果 表4 DebugCaseResult 参数 参数类型 描述 body String 响应内容 errorReason String 错误原因 header DebugCaseResultHeader object 请求头 name String 请求名称 responseTime Integer 响应时间 result Integer 调试结果（1：成功；） returnBody String 响应正文 returnHeader DebugCaseReturnHeader object 响应头 statusCode String 响应状态码 url String 请求地址 表5 DebugCaseResultHeader 参数 参数类型 描述 Connection String 连接 Content-Type String 内容类型 Host String 主机 表6 DebugCaseReturnHeader 参数 参数类型 描述 Connection String 连接 Content-Length String 内容长度 Content-Type String 内容类型 Date String 时间 Vary String 兼容性保留，当前版本未使用 状态码：501 表7 响应Body参数 参数 参数类型 描述 - String response message