文档首页/ 性能测试 CodeArts PerfTest/ API参考/ API/ 任务管理/ 修改任务关联用例
更新时间：2024-11-28 GMT+08:00
查看PDF
分享

修改任务关联用例

功能介绍

修改任务关联用例

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v3/{project_id}/tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

task_id

是

Integer

任务ID

请求参数

表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集合

响应参数

状态码： 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

请求示例

修改一个任务，任务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

success

501

unknown error

错误码

请参见错误码。

父主题： 任务管理

相关文档