Help Center/ CodeArts PerfTest/ API Reference/ API/ Case Management/ Debugging a Case (Old Version)

Updated on 2025-12-01 GMT+08:00

View PDF

Debugging a Case (Old Version)

Function

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsperftest:cpts:updatePerfTestProject	Write	cpts *	g:ResourceTag/<tag-key>	-	-

URI

POST /v1/{project_id}/test-suites/{test_suite_id}/tasks/{task_id}/cases/{case_id}/debug

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Method of obtaining instructions.
test_suite_id	Yes	Integer	Test project ID, which is the value of project_id in the response body of the API for creating a project.
task_id	Yes	Integer	Task ID, which is the value of task_id in the response body of the API for creating a task.
case_id	Yes	Integer	Case ID, which is the value of json.test_case_id in the response body of the API for creating a case.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	Integer	Status (9: debugging started).
cluster_id	Yes	Integer	Resource group ID.
cluster_type	Yes	String	Resource group type (shared-cluster-internet: shared resource group; private-cluster: private resource group).
without_package	Yes	Integer	Whether to use the pay-per-use billing mode when the VUM of the package is insufficient. The value is fixed at 0 in the current edition.
type	No	Integer	Type. 0 (default): transaction; 1: case.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Response code.
message	String	Response message.
extend	String	Extension information.
result	Array of DebugCaseResult objects	Result.

**Table 4** DebugCaseResult
Parameter	Type	Description
body	String	Response content.
errorReason	String	Error cause.
header	DebugCaseResultHeader object	Request header.
name	String	Request name.
responseTime	Integer	Response time.
result	Integer	Debugging result (1: successful).
returnBody	String	Response body.
returnHeader	DebugCaseReturnHeader object	Response header.
statusCode	String	Response status code.
url	String	Request URL.

**Table 5** DebugCaseResultHeader
Parameter	Type	Description
Connection	String	Connection.
Content-Type	String	Content type.
Host	String	Host.

**Table 6** DebugCaseReturnHeader
Parameter	Type	Description
Connection	String	Connection.
Content-Length	String	Content length.
Content-Type	String	Content type.
Date	String	Time.
Vary	String	This parameter is reserved for compatibility and is not used in the current edition.

Status code: 501

**Table 7** Response body parameters
Parameter	Type	Description
-	String	response message

Example Requests

Debugging the case whose ID is 1. Use the shared resource group to start debugging.

/v1/projectId/test-suites/testSuiteId/tasks/0/cases/1/debug

{
  "status" : 9,
  "cluster_id" : 0,
  "cluster_type" : "shared-cluster-internet",
  "without_package" : 1,
  "type" : 1
}

Example Responses

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