Debugging a Case

Function

This API is used to debug a case.

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 Obtaining a Project ID. Minimum: 0 Maximum: 64
test_suite_id	Yes	Integer	Test project ID. Minimum: 0 Maximum: 2147483647
task_id	Yes	Integer	Task ID. Minimum: 0 Maximum: 2147483647
case_id	Yes	Integer	Case ID. Minimum: 0 Maximum: 2147483647

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	Integer	Status (9: debugging started). Minimum: 0 Maximum: 2147483647
cluster_id	Yes	Integer	Resource group ID. Minimum: 0 Maximum: 2147483647
cluster_type	Yes	String	Resource group type (shared-cluster-internet: shared resource group; private-cluster: private resource group). Minimum: 0 Maximum: 1024
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. Minimum: 0 Maximum: 2147483647

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Response code. Minimum: 0 Maximum: 1024
message	String	Response message. Minimum: 0 Maximum: 1024
extend	String	Extension information. Minimum: 0 Maximum: 1024
result	Array of DebugCaseResult objects	Result. Array Length: 0 - 1024

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

**Table 5** DebugCaseResultHeader
Parameter	Type	Description
Connection	String	Connection. Minimum: 0 Maximum: 1024
Content-Type	String	Content type. Minimum: 0 Maximum: 1024
Host	String	Host. Minimum: 0 Maximum: 1024

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

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
}

Example Responses

Status code: 200

success

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "extend" : null,
  "result" : [ {
    "body" : "",
    "errorReason" : "",
    "header" : {
      "Content-Type" : "application/json",
      "Host" : "100.93.1.72:8443"
    },
    "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://100.93.1.72:8443/goserver/reflect"
  } ]
}