华为云用户手册

  • 请求示例 修改一个事务,事务的id是1,事务所属的工程ID是1,包括修改事务的请求信息。 /v1/{project_id}/templates/1 { "contents" : [ { "content" : [ { "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-31445", "protocol_type" : 2, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "https://www.domain-example.com" }, "content_type" : 2 } ], "content_id" : 2346, "index" : 0 } ], "description" : "", "enable_pre" : false, "for_loop_params" : [ ], "id" : 1, "name" : "transaction_test", "project_id" : 1, "temp_type" : 0 }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 Integer 事务ID project_id 是 Integer 工程ID name 是 String 事务名称 temp_type 否 Integer 事务类型 description 否 String 描述信息 for_loop_params 否 Array of objects 旧版本逻辑控制器字段,当前已未使用 enable_pre 否 Boolean 是否启用预置事务,当前版本未使用 contents 否 Array of TempContentInfo objects 事务脚本信息 表3 TempContentInfo 参数 是否必选 参数类型 描述 content_id 否 Integer 报文id或者事务ID或者插件ID content 否 Array of Content objects 内容 index 否 Integer 索引 data 否 Object 数据指令内容 data_type 否 Integer 数据指令类型(0:默认请求卡片;1:数据指令;201:循环指令;202:条件指令;301:集合点;203:vu百分比控制器;204:吞吐量控制器;302:插件请求) 表4 Content 参数 是否必选 参数类型 描述 content_type 否 Integer 用例卡片类型(1:思考时间;2:报文;3:检查点;4:变量提取) content 否 ContentInfo object 内容 表5 ContentInfo 参数 是否必选 参数类型 描述 body_type 否 Integer body类型(0:字符串;1:form-data格式;3:x-www-form-urlencoded格式) bodys 否 Array of objects bodys 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) 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重试次数 表6 ContentHeader 参数 是否必选 参数类型 描述 key 否 String 键 value 否 String 值
  • 请求示例 启动一个任务,任务的所属工程ID是1,任务的id是1,使用共享资源组启动。 /v1/{project_id}/test-suites/1/tasks/1 { "cluster_id" : 0, "enterprise_project_id" : "0", "cluster_type" : "shared-cluster-internet", "without_package" : 0, "network_info" : { "network_type" : "internet" }, "status" : 9 } 启动一个任务,任务的所属工程ID是1,任务的id是1。 /v1/{project_id}/test-suites/1/tasks/1 { "cluster_id" : -1, "enterprise_project_id" : "0", "cluster_type" : "shared-cluster-internet", "network_info" : { "network_type" : "internet" }, "status" : 2, "without_package" : 0 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 extend String 扩展信息 result UpdateTaskStatusResult object 状态更新结果 表5 UpdateTaskStatusResult 参数 参数类型 描述 task_run_id Integer 运行任务ID,即报告ID 状态码: 501 表6 响应Body参数 参数 参数类型 描述 - String response message
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 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)
  • 响应示例 状态码: 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,任务名修改为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 表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 bodys 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) 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集合
  • 请求示例 修改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 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 表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 bodys 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) 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 bodys 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) 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:用户主动终止(终止中状态))
  • 请求示例 修改一个id为1的工程,工程名字修改为ProjectTest,工程描述修改为description。 /v1/{project_id}/test-suites/1 { "id" : 1, "name" : "ProjectTest", "description" : "description", "variables_no_file" : [ ], "source" : 0, "external_params" : { } }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 Integer 工程ID name 是 String 工程名称 description 否 String 工程描述 variables_no_file 否 Array of strings 导入工程时,缺失的存在于变量文件中的变量 source 否 Integer 来源(0-PerfTest;2-CloudTest) external_params 否 Object 扩展参数
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 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 文本用例信息 表3 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 智能摸高模式下递增并发数 表4 StageKpiItems 参数 是否必选 参数类型 描述 average_response_time 否 StageKpiItem object 平均响应时间 success_rate 否 StageKpiItem object 成功率 表5 StageKpiItem 参数 是否必选 参数类型 描述 comparison 否 String 比较符 value 否 Integer 比较值 表6 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 是否禁用 表7 Content 参数 是否必选 参数类型 描述 content_type 否 Integer 用例卡片类型(1:思考时间;2:报文;3:检查点;4:变量提取) content 否 ContentInfo object 内容 表8 ContentInfo 参数 是否必选 参数类型 描述 body_type 否 Integer body类型(0:字符串;1:form-data格式;3:x-www-form-urlencoded格式) bodys 否 Array of objects bodys 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) 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重试次数 表9 ContentHeader 参数 是否必选 参数类型 描述 key 否 String 键 value 否 String 值 表10 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 测试步骤 表11 steps 参数 是否必选 参数类型 描述 expect_result 否 String 步骤描述 test_step 否 String 预期结果
  • URI PUT /v1/{project_id}/test-suites/{test_suite_id}/directory/{directory_id} 表1 路径参数 参数 是否必选 参数类型 描述 directory_id 是 Integer 目录ID project_id 是 String 项目ID,获取方式请参见获取项目ID。 test_suite_id 是 Integer 测试工程ID
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 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 文本用例信息 表3 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 智能摸高模式下递增并发数 表4 StageKpiItems 参数 是否必选 参数类型 描述 average_response_time 否 StageKpiItem object 平均响应时间 success_rate 否 StageKpiItem object 成功率 表5 StageKpiItem 参数 是否必选 参数类型 描述 comparison 否 String 比较符 value 否 Integer 比较值 表6 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 是否禁用 表7 Content 参数 是否必选 参数类型 描述 content_type 否 Integer 用例卡片类型(1:思考时间;2:报文;3:检查点;4:变量提取) content 否 ContentInfo object 内容 表8 ContentInfo 参数 是否必选 参数类型 描述 body_type 否 Integer body类型(0:字符串;1:form-data格式;3:x-www-form-urlencoded格式) bodys 否 Array of objects bodys 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) 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重试次数 表9 ContentHeader 参数 是否必选 参数类型 描述 key 否 String 键 value 否 String 值 表10 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 测试步骤 表11 steps 参数 是否必选 参数类型 描述 expect_result 否 String 步骤描述 test_step 否 String 预期结果
  • 请求示例 查询事务集,事务所属工程ID是1。 /v1/projectId/all-templates/1 { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "temps" : [ { "description" : "", "id" : 155175, "is_quoted" : false, "name" : "test", "temp_type" : 0, "update_time" : "2023-06-16T15:49:19.128871+08:00" } ] }
  • 响应示例 状态码: 200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "temps" : [ { "description" : "", "id" : 114448, "is_quoted" : false, "name" : "temp1", "temp_type" : 0, "update_time" : "2022-07-20T17:49:20.984763+08:00" }, { "description" : "", "id" : 115964, "is_quoted" : false, "name" : "temp2", "temp_type" : 0, "update_time" : "2022-07-20T17:38:12.696491+08:00" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 temps Array of TempDetailInfo objects temps 表4 TempDetailInfo 参数 参数类型 描述 description String 描述 id Integer 事务ID is_quoted Boolean 是否被引用 name String 事务名称 temp_type Integer 事务类型(已弃用,兼容性保留) update_time String 更新时间 状态码: 501 表5 响应Body参数 参数 参数类型 描述 - String response message
  • URI GET /v1/{project_id}/all-templates/{test_suite_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 test_suite_id 是 Integer 测试工程ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移 limit 否 Integer 查询数量
  • 请求示例 查询事务的详情信息,事务的id是1。 /v1/{project_id}/templates/1 { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "temp_info" : { "id" : 155175, "project_id" : 403931, "name" : "test", "description" : "", "variables" : null, "contents" : [ { "content_id" : 155175, "content" : [ { "content_type" : 2, "content" : { "_adressValue" : "http://1.1.1.1", "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-8015", "protocol_type" : 1, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "http://1.1.1.1" } } ], "index" : -1, "selected_temp_name" : "", "data" : null, "data_type" : 0, "conditions" : null, "is_disabled" : false, "is_continue" : false } ], "temp_type" : 0, "for_loop_params" : [ ], "logic_controller" : { "for_loop_params" : null, "condition" : null }, "enable_pre" : false } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 temp_info TempInfo object 事务详情 表3 TempInfo 参数 参数类型 描述 id Integer 事务ID project_id Integer 工程ID name String 事务名称 description String 事务描述 variables String 变量 contents Array of objects 事务脚本信息 temp_type Integer 事务类型(弃用) for_loop_params Array of objects 旧版本逻辑控制器字段,当前已未使用 logic_controller LogicController object 逻辑控制器信息 enable_pre Boolean 是否启用预置事务,当前版本未使用 表4 LogicController 参数 参数类型 描述 for_loop_params String 旧版本逻辑控制器字段,当前已未使用 condition String 逻辑控制器条件 状态码: 501 表5 响应Body参数 参数 参数类型 描述 - String response message
  • 响应示例 状态码: 200 success { "code" : "SVCSTG.CPTS.0000000", "message" : "success", "temp_info" : { "id" : 21531, "project_id" : 17543, "name" : "transaction", "description" : "", "variables" : null, "contents" : [ { "content_id" : 21531, "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-73387", "protocol_type" : 2, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "https://www.domain-example.com" } } ], "index" : -1, "selected_temp_name" : "", "data" : null, "data_type" : 0, "conditions" : null, "is_disabled" : false, "is_continue" : false } ], "temp_type" : 0, "for_loop_params" : [ ], "logic_controller" : { "for_loop_params" : null, "condition" : null }, "enable_pre" : false } }
  • 响应示例 状态码: 200 success { "code" : "SVCSTG.CPTS.0000000", "extend" : [ ], "message" : "success", "tasks" : [ { "bench_concurrent" : 100, "description" : "", "id" : 52631, "name" : "task1", "operate_mode" : 2, "parallel" : true, "task_run_info" : { "id" : 0, "run_type" : 0 }, "update_time" : "2022-01-05T11:16:08.415954+08:00" }, { "bench_concurrent" : 100, "description" : "", "id" : 52621, "name" : "task2", "operate_mode" : 2, "parallel" : true, "task_run_info" : { "id" : 0, "run_type" : 0 }, "update_time" : "2021-12-31T15:43:53.014385+08:00" } ] }
  • URI GET /v1/{project_id}/all-tasks/{test_suite_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 test_suite_id 是 Integer 测试工程ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移 limit 否 Integer 查询数量
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 extend Array of strings 扩展信息 message String 响应消息 tasks Array of Task objects 工程集详细信息 表4 Task 参数 参数类型 描述 bench_concurrent Integer 基准并发 description String 描述信息 id Integer 任务ID name String 任务名称 operate_mode Integer 任务压测模式 task_run_info TaskRunInfo object 任务运行信息 update_time String 更新时间 parallel Boolean 任务间用例是否并行执行 表5 TaskRunInfo 参数 参数类型 描述 id Integer 任务ID run_type Integer 任务类型(0:旧版本任务;1:新版本任务) 状态码: 501 表6 响应Body参数 参数 参数类型 描述 - String response message
  • URI GET /v2/{project_id}/task-run-infos/{task_run_id}/case-run-infos/{case_run_id}/detail/{detail_id}/chart 表1 路径参数 参数 是否必选 参数类型 描述 task_run_id 是 Integer 运行任务ID,即报告ID。启动任务(更新任务状态或批量启停任务)接口,会返回运行任务ID。 case_run_id 是 Integer 运行用例ID,通过报告管理中的“当前任务用例列表”接口获取:使用任务运行id(task_run_id)作为路径参数,可以查询到该报告关联的用例运行id集合,即返回结构体中result.case_aw_info_list[index].testcaseId为索引为index的运行用例ID。 detail_id 是 String 运行用例详情ID,通过报告管理中的“当前任务用例列表”接口获取:使用运行任务ID(task_run_id)作为路径参数,可以查询到该报告关联的运行用例详情ID集合,即返回结构体中result.case_aw_info_list[index].id为索引为index的运行用例详情ID(detail_id)。 project_id 是 String 项目ID,获取方式请参见获取项目ID。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 message String 响应消息 taskInfo TaskInfo object 任务详情 表3 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 任务间用例是否并行执行 表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 bodys 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) 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:用户主动终止(终止中状态)) 状态码: 501 表16 响应Body参数 参数 参数类型 描述 - String response message
共100000条