Help Center/ CodeArts PerfTest/ API Reference/ API/ Task Management/ Modifying a Task (Old Edition)

Updated on 2024-04-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying a Task (Old Edition)

Function

This API is used to modify a task on the old UI.

URI

PUT /v1/{project_id}/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID. Minimum: 0 Maximum: 64
task_id	Yes	Integer	Task ID. Minimum: 0 Maximum: 2147483647

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
id	Yes	Integer	Task ID. Minimum: 0 Maximum: 2147483647
name	Yes	String	Task name. Minimum: 1 Maximum: 42
description	No	String	Description. Minimum: 0 Maximum: 1024
project_id	Yes	Integer	Project ID. Minimum: 0 Maximum: 2147483647
run_status	No	Integer	Task running status (9: waiting to run; 0: running; 1: paused; 2: ended; 3: stopped abnormally; 4: stopped by the user (completed); 5: stopped by the user). Minimum: 0 Maximum: 2147483647
run_type	No	Integer	Task type (0: old edition task; 1: new edition task). Minimum: 0 Maximum: 2147483647
task_run_info	No	TaskRunInfo object	Task running information.
case_list	No	Array of CaseInfoDetail objects	Case information. Array Length: 0 - 1024
operate_mode	No	Integer	Pressure phase mode (0: by duration; 1: by count). Minimum: 0 Maximum: 2147483647
bench_concurrent	No	Integer	Benchmark concurrency. Minimum: 0 Maximum: 2147483647
related_temp_running_data	No	Array of RelatedTempRunningData objects	Brief information about the latest running report. Array Length: 0 - 1024

**Table 3** TaskRunInfo
Parameter	Mandatory	Type	Description
id	No	Integer	Task ID. Minimum: 0 Maximum: 2147483647
run_type	No	Integer	Task type (0: old edition task; 1: new edition task). Minimum: 0 Maximum: 2147483647

**Table 4** CaseInfoDetail
Parameter	Mandatory	Type	Description
case_id	No	Integer	Case ID. Minimum: 0 Maximum: 2147483647
name	No	String	Case name. Minimum: 0 Maximum: 1024
case_type	No	Integer	Case type (0: normal case). Minimum: 0 Maximum: 2147483647
contents	No	Array of Contents objects	Case script information. Array Length: 0 - 1024
for_loop_params	No	Array of objects	Logic controller field of the old edition. This parameter is not used in the current edition. Array Length: 0 - 10240
increase_setting	No	Array of objects	Gradient increment. Array Length: 0 - 10240
stages	No	Array of TestCaseStage objects	Phase information. Array Length: 0 - 1024
status	No	Integer	Status (0: deleted; 1: enabled; 2: disabled). Minimum: 0 Maximum: 2147483647
temp_id	No	Integer	Case ID. Minimum: 0 Maximum: 2147483647
sort	No	Integer	Sorting field.
directory_id	No	Integer	Directory ID of the case. This parameter is optional for APIs of earlier versions. Minimum: 0 Maximum: 2147483647
setup_contents	No	Array of Contents objects	Preparations.
user_replicas	No	Integer	Actuators. Minimum: 0 Maximum: 2147483647
collect_log_policy	No	Integer	Log collection policy (0: request mode; 1: case mode). Minimum: 0 Maximum: 32
link_app_list	No	Array of integers	Associated full-link application list.
case_info	No	CaseDoc object	Text case information.

**Table 5** TestCaseStage
Parameter	Mandatory	Type	Description
operate_mode	No	Integer	Pressure phase mode (0: by duration; 1: by count).
name	No	String	Phase name.
time	No	Integer	Duration, in seconds.
start_time	No	Integer	Start time.
end_time	No	Integer	End time.
issue_num	No	Integer	Maximum concurrency.
count	No	Integer	Total transmission times.
pressure_mode	No	Integer	Pressure mode (0: concurrent mode; 1: TPS mode; 2: high pressure mode; 3: surge concurrency mode; 4: surge TPS mode; 5: flapping concurrency mode; 6: flapping TPS mode; 7: intelligent high pressure mode).
tps_value	No	Integer	TPS value in TPS mode.
current_user_num	No	Integer	Start concurrency.
current_tps	No	Integer	Start TPS value.
voltage_regulating_mode	No	Integer	Pressure adjustment mode (0: automated; 1: manual).
maximum	No	Integer	Maximum concurrency in the surge mode.
minimum	No	Integer	Minimum concurrency in the surge mode.
loop_count	No	Integer	Oscillation/surge times.
max_duration	No	Integer	Peak duration in the surge mode.
ramp_up	No	Integer	Ramp up (in seconds) in the peakload mode.
peak_load_kpis	No	StageKpiItems object	Expected KPI.
step_duration	No	Integer	Single-step execution duration in the intelligent peakload mode.
step_size	No	Integer	Increase concurrency in the intelligent peakload mode.

**Table 6** StageKpiItems
Parameter	Mandatory	Type	Description
average_response_time	No	StageKpiItem object	Average response time.
success_rate	No	StageKpiItem object	Success rate.

**Table 7** StageKpiItem
Parameter	Mandatory	Type	Description
comparison	No	String	Comparison operator.
value	No	Integer	Comparison value.

**Table 8** Contents
Parameter	Mandatory	Type	Description
content_id	No	Integer	Transaction ID. If the transaction ID is not 0, the card is a transaction. If it is 0, the card is not a transaction. Minimum: 0 Maximum: 2147483647
content	No	Array of Content objects	Content. Array Length: 0 - 1000
index	No	Integer	Sorting index. Minimum: 0 Maximum: 2147483647
selected_temp_name	No	String	Name of the selected transaction or case. Minimum: 0 Maximum: 40960
data	No	Object	Data to which the loop and condition controller apply.
data_type	No	Integer	Type (0: default request; 1: data instruction; 201: cycle instruction; 202: condition instruction; 301: rendezvous point). Minimum: 0 Maximum: 2147483647
conditions	No	Object	If the type is 202 (condition instruction), this field configures the condition.
is_disabled	No	Boolean	Whether to disable the AW.

**Table 9** Content
Parameter	Mandatory	Type	Description
content_type	No	Integer	Case card type (1: think time; 2: packet; 3: checkpoint; 4: variable extraction). Minimum: 0 Maximum: 2147483647
content	No	ContentInfo object	Content.

**Table 10** ContentInfo
Parameter	Mandatory	Type	Description
body_type	No	Integer	Body type (0: string; 1: form-data format; 3: x-www-form-urlencoded format). Minimum: 0 Maximum: 2147483647
bodys	No	Array of objects	bodys
check_end_length	No	Object	Length of the data returned through TCP/UDP.
check_end_str	No	Object	End character returned through TCP/UDP.
check_end_type	No	Object	End type (1: data length; 2: end character) returned through TCP/UDP.
connect_timeout	No	Integer	Timeout duration. Minimum: 0 Maximum: 2147483647
connect_type	No	Integer	Connection settings. This parameter is not used in the current edition. Minimum: 0 Maximum: 2147483647
headers	No	Array of ContentHeader objects	Request header. Array Length: 0 - 1024
http_version	No	String	HTTP version. Minimum: 0 Maximum: 1024
method	No	String	HTTP method. Minimum: 0 Maximum: 1024
name	No	String	Case name. Minimum: 0 Maximum: 1024
protocol_type	No	Integer	Protocol type (1: HTTP; 2: HTTPS; 3: TCP; 4: UDP; 7: HLS/RTMP; 9: WebSocket; 10: HTTP-FLV). Minimum: 0 Maximum: 2147483647
return_timeout	No	Integer	Response timeout. Minimum: 0 Maximum: 2147483647
return_timeout_param	No	String	Response timeout parameter. Minimum: 0 Maximum: 40960
url	No	String	Request URL. Minimum: 0 Maximum: 40960
rtmp_url	No	String	RTMP address. Minimum: 0 Maximum: 40960
flv_url	No	String	FLV address. Minimum: 0 Maximum: 40960
bitrate_type	No	Integer	Resolution policy. Minimum: 0 Maximum: 128
duration	No	Integer	Duration. Minimum: 0 Maximum: 2147483647
retry_delay	No	Integer	HLS retry delay. Minimum: 0 Maximum: 2147483647
retry_time	No	Integer	HLS retries. Minimum: 0 Maximum: 2147483647

**Table 11** ContentHeader
Parameter	Mandatory	Type	Description
key	No	String	Key. Minimum: 0 Maximum: 40960
value	No	String	Value. Minimum: 0 Maximum: 40960

**Table 12** CaseDoc
Parameter	Mandatory	Type	Description
description	No	String	Case description. Minimum: 0 Maximum: 2147483647
label_names	No	Array of strings	Tags.
preparation	No	String	Preparations. Minimum: 0 Maximum: 2147483647
rank	No	Integer	Case level (0: L0, 1: L1, 2: L2, 3: L3, 4: L4). Minimum: 0 Maximum: 64
status_code	No	Integer	Status (0: new; 5: designing; 6: testing; 7: completed).
steps	No	Array of steps objects	Procedure.

**Table 13** steps
Parameter	Mandatory	Type	Description
expect_result	No	String	Step description. Minimum: 0 Maximum: 2147483647
test_step	No	String	Expected result. Minimum: 0 Maximum: 2147483647

**Table 14** RelatedTempRunningData
Parameter	Mandatory	Type	Description
task_run_info_id	No	Integer	ID of a running task, that is, the report ID. When a task API (for updating task status or starting or stopping tasks in batches) is called, the running task ID is returned. Minimum: 0 Maximum: 2147483647
related_temp_running_id	No	Integer	ID of a running case. The value is same as that of the running case ID (case_run_id) of other APIs (such as a report API). Minimum: 0 Maximum: 2147483647
temp_id	No	Integer	Case ID. Minimum: 0 Maximum: 2147483647
temp_name	No	String	Case name. Minimum: 0 Maximum: 4096
content_method_url	No	Array of strings	Request information, including the request name, method, and URL.
related_temp_running_data	No	Array of TempRunningData objects	Brief information about the latest running report.

**Table 15** TempRunningData
Parameter	Mandatory	Type	Description
content_method_url	No	Array of strings	Request information, including the request name, method, and URL.
crawler_status	No	Integer	Request running status (0: normal response; 1: parsing failed; 2: comparison failed; 3: response timed out).
related_temp_running_id	No	Integer	ID of a running case. The value is same as that of the running case ID (case_run_id) of other APIs (such as a report API).
task_run_info_id	No	Integer	ID of a running task, that is, the report ID. When a task API (for updating task status or starting or stopping tasks in batches) is called, the running task ID is returned.
temp_id	No	Integer	Case or transaction ID.
temp_name	No	String	Case or transaction name.
temp_running_status	No	Integer	Running status (9: waiting to run; 0: running; 2: ended; 3: stopped abnormally; 4: stopped by the user (completely stopped); 5: stopped by the user (stopping)).

Response Parameters

Status code: 200

**Table 16** Response body parameters
Parameter	Type	Description
code	String	Response code. Minimum: 0 Maximum: 1024
message	String	Response message. Minimum: 0 Maximum: 1024
taskInfo	TaskInfo object	Task details.

**Table 17** TaskInfo
Parameter	Type	Description
bench_concurrent	Integer	Benchmark concurrency. Minimum: 0 Maximum: 2147483647
case_list	Array of CaseInfoDetail objects	Case ID list. Array Length: 0 - 1000
create_time	String	Creation time.
description	String	Description. Minimum: 0 Maximum: 1024
name	String	Task name. Minimum: 0 Maximum: 1024
operate_mode	Integer	Task mode (0: by duration; 1: by count; 2: both). Minimum: 0 Maximum: 2147483647
project_id	Integer	ID of the project to which the task belongs. Minimum: 0 Maximum: 2147483647
related_temp_running_data	Array of RelatedTempRunningData objects	Brief information about the latest running report, including the running task ID, that is, the task_run_info_id of the object. ID of a running case, that is, related_temp_running_id of the object. Array Length: 0 - 1024
run_status	Integer	Task running status (9: waiting to run; 0: running; 1: paused; 2: ended; 3: stopped abnormally; 4: stopped by the user (completed); 5: stopped by the user). Minimum: 0 Maximum: 2147483647
update_time	String	Time when a task is updated. Minimum: 0 Maximum: 1024
parallel	Boolean	Whether cases are executed in parallel between tasks.

**Table 18** CaseInfoDetail
Parameter	Type	Description
case_id	Integer	Case ID. Minimum: 0 Maximum: 2147483647
name	String	Case name. Minimum: 0 Maximum: 1024
case_type	Integer	Case type (0: normal case). Minimum: 0 Maximum: 2147483647
contents	Array of Contents objects	Case script information. Array Length: 0 - 1024
for_loop_params	Array of objects	Logic controller field of the old edition. This parameter is not used in the current edition. Array Length: 0 - 10240
increase_setting	Array of objects	Gradient increment. Array Length: 0 - 10240
stages	Array of TestCaseStage objects	Phase information. Array Length: 0 - 1024
status	Integer	Status (0: deleted; 1: enabled; 2: disabled). Minimum: 0 Maximum: 2147483647
temp_id	Integer	Case ID. Minimum: 0 Maximum: 2147483647
sort	Integer	Sorting field.
directory_id	Integer	Directory ID of the case. This parameter is optional for APIs of earlier versions. Minimum: 0 Maximum: 2147483647
setup_contents	Array of Contents objects	Preparations.
user_replicas	Integer	Actuators. Minimum: 0 Maximum: 2147483647
collect_log_policy	Integer	Log collection policy (0: request mode; 1: case mode). Minimum: 0 Maximum: 32
link_app_list	Array of integers	Associated full-link application list.
case_info	CaseDoc object	Text case information.

**Table 19** TestCaseStage
Parameter	Type	Description
operate_mode	Integer	Pressure phase mode (0: by duration; 1: by count).
name	String	Phase name.
time	Integer	Duration, in seconds.
start_time	Integer	Start time.
end_time	Integer	End time.
issue_num	Integer	Maximum concurrency.
count	Integer	Total transmission times.
pressure_mode	Integer	Pressure mode (0: concurrent mode; 1: TPS mode; 2: high pressure mode; 3: surge concurrency mode; 4: surge TPS mode; 5: flapping concurrency mode; 6: flapping TPS mode; 7: intelligent high pressure mode).
tps_value	Integer	TPS value in TPS mode.
current_user_num	Integer	Start concurrency.
current_tps	Integer	Start TPS value.
voltage_regulating_mode	Integer	Pressure adjustment mode (0: automated; 1: manual).
maximum	Integer	Maximum concurrency in the surge mode.
minimum	Integer	Minimum concurrency in the surge mode.
loop_count	Integer	Oscillation/surge times.
max_duration	Integer	Peak duration in the surge mode.
ramp_up	Integer	Ramp up (in seconds) in the peakload mode.
peak_load_kpis	StageKpiItems object	Expected KPI.
step_duration	Integer	Single-step execution duration in the intelligent peakload mode.
step_size	Integer	Increase concurrency in the intelligent peakload mode.

**Table 20** StageKpiItems
Parameter	Type	Description
average_response_time	StageKpiItem object	Average response time.
success_rate	StageKpiItem object	Success rate.

**Table 21** StageKpiItem
Parameter	Type	Description
comparison	String	Comparison operator.
value	Integer	Comparison value.

**Table 22** Contents
Parameter	Type	Description
content_id	Integer	Transaction ID. If the transaction ID is not 0, the card is a transaction. If it is 0, the card is not a transaction. Minimum: 0 Maximum: 2147483647
content	Array of Content objects	Content. Array Length: 0 - 1000
index	Integer	Sorting index. Minimum: 0 Maximum: 2147483647
selected_temp_name	String	Name of the selected transaction or case. Minimum: 0 Maximum: 40960
data	Object	Data to which the loop and condition controller apply.
data_type	Integer	Type (0: default request; 1: data instruction; 201: cycle instruction; 202: condition instruction; 301: rendezvous point). Minimum: 0 Maximum: 2147483647
conditions	Object	If the type is 202 (condition instruction), this field configures the condition.
is_disabled	Boolean	Whether to disable the AW.

**Table 23** Content
Parameter	Type	Description
content_type	Integer	Case card type (1: think time; 2: packet; 3: checkpoint; 4: variable extraction). Minimum: 0 Maximum: 2147483647
content	ContentInfo object	Content.

**Table 24** ContentInfo
Parameter	Type	Description
body_type	Integer	Body type (0: string; 1: form-data format; 3: x-www-form-urlencoded format). Minimum: 0 Maximum: 2147483647
bodys	Array of objects	bodys
check_end_length	Object	Length of the data returned through TCP/UDP.
check_end_str	Object	End character returned through TCP/UDP.
check_end_type	Object	End type (1: data length; 2: end character) returned through TCP/UDP.
connect_timeout	Integer	Timeout duration. Minimum: 0 Maximum: 2147483647
connect_type	Integer	Connection settings. This parameter is not used in the current edition. Minimum: 0 Maximum: 2147483647
headers	Array of ContentHeader objects	Request header. Array Length: 0 - 1024
http_version	String	HTTP version. Minimum: 0 Maximum: 1024
method	String	HTTP method. Minimum: 0 Maximum: 1024
name	String	Case name. Minimum: 0 Maximum: 1024
protocol_type	Integer	Protocol type (1: HTTP; 2: HTTPS; 3: TCP; 4: UDP; 7: HLS/RTMP; 9: WebSocket; 10: HTTP-FLV). Minimum: 0 Maximum: 2147483647
return_timeout	Integer	Response timeout. Minimum: 0 Maximum: 2147483647
return_timeout_param	String	Response timeout parameter. Minimum: 0 Maximum: 40960
url	String	Request URL. Minimum: 0 Maximum: 40960
rtmp_url	String	RTMP address. Minimum: 0 Maximum: 40960
flv_url	String	FLV address. Minimum: 0 Maximum: 40960
bitrate_type	Integer	Resolution policy. Minimum: 0 Maximum: 128
duration	Integer	Duration. Minimum: 0 Maximum: 2147483647
retry_delay	Integer	HLS retry delay. Minimum: 0 Maximum: 2147483647
retry_time	Integer	HLS retries. Minimum: 0 Maximum: 2147483647

**Table 25** ContentHeader
Parameter	Type	Description
key	String	Key. Minimum: 0 Maximum: 40960
value	String	Value. Minimum: 0 Maximum: 40960

**Table 26** CaseDoc
Parameter	Type	Description
description	String	Case description. Minimum: 0 Maximum: 2147483647
label_names	Array of strings	Tags.
preparation	String	Preparations. Minimum: 0 Maximum: 2147483647
rank	Integer	Case level (0: L0, 1: L1, 2: L2, 3: L3, 4: L4). Minimum: 0 Maximum: 64
status_code	Integer	Status (0: new; 5: designing; 6: testing; 7: completed).
steps	Array of steps objects	Procedure.

**Table 27** steps
Parameter	Type	Description
expect_result	String	Step description. Minimum: 0 Maximum: 2147483647
test_step	String	Expected result. Minimum: 0 Maximum: 2147483647

**Table 28** RelatedTempRunningData
Parameter	Type	Description
task_run_info_id	Integer	ID of a running task, that is, the report ID. When a task API (for updating task status or starting or stopping tasks in batches) is called, the running task ID is returned. Minimum: 0 Maximum: 2147483647
related_temp_running_id	Integer	ID of a running case. The value is same as that of the running case ID (case_run_id) of other APIs (such as a report API). Minimum: 0 Maximum: 2147483647
temp_id	Integer	Case ID. Minimum: 0 Maximum: 2147483647
temp_name	String	Case name. Minimum: 0 Maximum: 4096
content_method_url	Array of strings	Request information, including the request name, method, and URL.
related_temp_running_data	Array of TempRunningData objects	Brief information about the latest running report.

**Table 29** TempRunningData
Parameter	Type	Description
content_method_url	Array of strings	Request information, including the request name, method, and URL.
crawler_status	Integer	Request running status (0: normal response; 1: parsing failed; 2: comparison failed; 3: response timed out).
related_temp_running_id	Integer	ID of a running case. The value is same as that of the running case ID (case_run_id) of other APIs (such as a report API).
task_run_info_id	Integer	ID of a running task, that is, the report ID. When a task API (for updating task status or starting or stopping tasks in batches) is called, the running task ID is returned.
temp_id	Integer	Case or transaction ID.
temp_name	String	Case or transaction name.
temp_running_status	Integer	Running status (9: waiting to run; 0: running; 2: ended; 3: stopped abnormally; 4: stopped by the user (completely stopped); 5: stopped by the user (stopping)).

Example Requests

Changing the name of the task whose ID is 1 to 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"
  } ]
}

Example Responses

Status code: 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"
  }
}