查询任务(旧版)
功能介绍
查询任务(旧版)
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/tasks/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 最小长度:0 最大长度:64 |
task_id |
是 |
Integer |
任务ID 最小值:0 最大值:2147483647 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
响应码 最小长度:0 最大长度:1024 |
message |
String |
响应消息 最小长度:0 最大长度:1024 |
taskInfo |
TaskInfo object |
任务详情 |
参数 |
参数类型 |
描述 |
---|---|---|
bench_concurrent |
Integer |
基准并发 最小值:0 最大值:2147483647 |
case_list |
Array of CaseInfoDetail objects |
用例ID列表 数组长度:0 - 1000 |
create_time |
String |
创建时间 |
description |
String |
描述信息 最小长度:0 最大长度:1024 |
name |
String |
任务名称 最小长度:0 最大长度:1024 |
operate_mode |
Integer |
任务模式(0:时长模式;1:次数模式;2:混合模式) 最小值:0 最大值:2147483647 |
project_id |
Integer |
任务所属工程ID 最小值:0 最大值:2147483647 |
related_temp_running_data |
Array of RelatedTempRunningData objects |
最近一次运行的报告简略信息,包括运行任务ID,即本对象的task_run_info_id。运行用例ID,即本对象的related_temp_running_id。 数组长度:0 - 1024 |
run_status |
Integer |
任务运行状态(9:等待运行;0:运行中;1:暂停;2:结束; 3:异常中止;4:用户主动终止(完成状态);5:用户主动终止) 最小值:0 最大值:2147483647 |
update_time |
String |
任务更新时间 最小长度:0 最大长度:1024 |
parallel |
Boolean |
任务间用例是否并行执行 |
参数 |
参数类型 |
描述 |
---|---|---|
case_id |
Integer |
用例ID 最小值:0 最大值:2147483647 |
name |
String |
用例名称 最小长度:0 最大长度:1024 |
case_type |
Integer |
用例类型(0:常规用例;) 最小值:0 最大值:2147483647 |
contents |
Array of Contents objects |
用例脚本信息 数组长度:0 - 1024 |
for_loop_params |
Array of objects |
旧版本逻辑控制器字段,当前已未使用 数组长度:0 - 10240 |
increase_setting |
Array of objects |
梯度递增 数组长度:0 - 10240 |
stages |
Array of TestCaseStage objects |
阶段信息 数组长度:0 - 1024 |
status |
Integer |
状态,0:已删除;1:启用;2:禁用 最小值:0 最大值:2147483647 |
temp_id |
Integer |
用例ID 最小值:0 最大值:2147483647 |
sort |
Integer |
排序字段 |
directory_id |
Integer |
用例所属目录ID(旧版接口可不传) 最小值:0 最大值:2147483647 |
setup_contents |
Array of Contents objects |
前置步骤 |
user_replicas |
Integer |
执行器个数 最小值:0 最大值:2147483647 |
collect_log_policy |
Integer |
日志采集策略(0-请求模式;1-用例模式) 最小值:0 最大值:32 |
link_app_list |
Array of integers |
关联全链路应用列表 |
case_info |
CaseDoc object |
文本用例信息 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
智能摸高模式下递增并发数 |
参数 |
参数类型 |
描述 |
---|---|---|
average_response_time |
StageKpiItem object |
平均响应时间 |
success_rate |
StageKpiItem object |
成功率 |
参数 |
参数类型 |
描述 |
---|---|---|
content_id |
Integer |
事务ID,若不为0表示此卡片为事务;为0表示非事务 最小值:0 最大值:2147483647 |
content |
Array of Content objects |
内容 数组长度:0 - 1000 |
index |
Integer |
排序索引标识 最小值:0 最大值:2147483647 |
selected_temp_name |
String |
选择的事务或者用例名称 最小长度:0 最大长度:40960 |
data |
Object |
数据(循环、条件控制器作用的数据) |
data_type |
Integer |
数据指令类型(0:默认请求卡片;1:数据指令;201:循环指令;202:条件指令;301:集合点;203:vu百分比控制器;204:吞吐量控制器;302:插件请求) 最小值:0 最大值:2147483647 |
conditions |
Object |
若类型为202:条件指令,该字段为条件配置 |
is_disabled |
Boolean |
是否禁用 |
参数 |
参数类型 |
描述 |
---|---|---|
content_type |
Integer |
用例卡片类型(1:思考时间;2:报文;3:检查点;4:变量提取) 最小值:0 最大值:2147483647 |
content |
ContentInfo object |
内容 |
参数 |
参数类型 |
描述 |
---|---|---|
body_type |
Integer |
body类型(0:字符串;1:form-data格式;3:x-www-form-urlencoded格式) 最小值:0 最大值:2147483647 |
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 |
超时时间 最小值:0 最大值:2147483647 |
connect_type |
Integer |
连接设置,当前版本已未使用 最小值:0 最大值:2147483647 |
headers |
Array of ContentHeader objects |
请求头 数组长度:0 - 1024 |
http_version |
String |
HTTP版本 最小长度:0 最大长度:1024 |
method |
String |
HTTP方法 最小长度:0 最大长度:1024 |
name |
String |
用例名称 最小长度:0 最大长度:1024 |
protocol_type |
Integer |
协议类型(1:HTTP;2:HTTPS;3:TCP;4:UDP;7:HLS/RTMP;9:WebSocket;10:HTTP-FLV) 最小值:0 最大值:2147483647 |
return_timeout |
Integer |
响应超时 最小值:0 最大值:2147483647 |
return_timeout_param |
String |
响应超时参数 最小长度:0 最大长度:40960 |
url |
String |
请求地址 最小长度:0 最大长度:40960 |
rtmp_url |
String |
rtmp地址 最小长度:0 最大长度:40960 |
flv_url |
String |
flv地址 最小长度:0 最大长度:40960 |
bitrate_type |
Integer |
分辨率策略 最小值:0 最大值:128 |
duration |
Integer |
持续时间 最小值:0 最大值:2147483647 |
retry_delay |
Integer |
HLS重试延迟时间 最小值:0 最大值:2147483647 |
retry_time |
Integer |
HLS重试次数 最小值:0 最大值:2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
用例描述信息 最小长度:0 最大长度:2147483647 |
label_names |
Array of strings |
标签 |
preparation |
String |
前置条件 最小长度:0 最大长度:2147483647 |
rank |
Integer |
用例等级(0-L0;1-L1;2-L2;3-L3;4-L4;) 最小值:0 最大值:64 |
status_code |
Integer |
状态(0-新建;5-设计中;6-测试中;7-完成;) |
steps |
Array of steps objects |
测试步骤 |
参数 |
参数类型 |
描述 |
---|---|---|
expect_result |
String |
步骤描述 最小长度:0 最大长度:2147483647 |
test_step |
String |
预期结果 最小长度:0 最大长度:2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
task_run_info_id |
Integer |
运行任务ID,即报告ID。启动任务(更新任务状态或批量启停任务)接口,会返回运行任务ID。 最小值:0 最大值:2147483647 |
related_temp_running_id |
Integer |
运行用例ID。对应其他(如报告)接口的运行用例ID(case_run_id)。 最小值:0 最大值:2147483647 |
temp_id |
Integer |
用例ID 最小值:0 最大值:2147483647 |
temp_name |
String |
用例名称 最小长度:0 最大长度:4096 |
content_method_url |
Array of strings |
请求信息,包括请求名称、方法、URL信息 |
related_temp_running_data |
Array of TempRunningData objects |
最近一次运行的报告简略信息 |
参数 |
参数类型 |
描述 |
---|---|---|
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的任务的详情信息。
/v1/{project_id}/tasks/1
响应示例
状态码: 200
success
{ "code" : "SVCSTG.CPTS.0000000", "message" : "success", "taskInfo" : { "bench_concurrent" : 100, "case_list" : [ { "case_id" : 18393, "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-33419", "protocol_type" : 2, "return_timeout" : 5000, "return_timeout_param" : null, "url" : "https://www.domain-example.com" } } ], "index" : 0, "selected_temp_name" : "", "data" : null, "data_type" : 0, "conditions" : null, "is_disabled" : false } ], "for_loop_params" : [ ], "increase_setting" : [ ], "name" : "case", "sort" : 1, "stages" : [ { "operate_mode" : 0, "name" : "Stage-pd44", "time" : 60, "start_time" : 0, "end_time" : 0, "issue_num" : 10, "count" : 1, "pressure_mode" : 0, "tps_value" : 1, "current_user_num" : 10, "current_tps" : 1, "voltage_regulating_mode" : 0, "maximum" : 3, "minimum" : 1, "loop_count" : 2, "max_duration" : 30, "ramp_up" : 30, "peak_load_kpis" : { "average_response_time" : { "comparison" : "<=", "value" : 60000 }, "success_rate" : { "comparison" : ">=", "value" : 0 } }, "step_duration" : 30, "step_size" : 1 } ], "status" : 1, "temp_id" : 0 } ], "create_time" : "2022-09-20T14:23:42.87449+08:00", "description" : "", "name" : "task", "operate_mode" : 2, "parallel" : false, "project_id" : 17543, "related_temp_running_data" : [ { "content_method_url" : [ "testRequest#GET#https://www.example.com" ], "crawler_status" : 9, "related_temp_running_id" : 93868, "task_run_info_id" : 79515, "temp_id" : 0, "temp_name" : "testCase", "temp_running_status" : 2 } ], "run_status" : 2, "update_time" : "2022-09-20T14:23:43.579707+08:00" } }
状态码
状态码 |
描述 |
---|---|
200 |
success |
501 |
unknown error |
错误码
请参见错误码。