Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Stopping a Scan Task
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Stopping a Scan Task

Function

This API is used to stop a scan task.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/scan/job/task/{task_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

msg

String

Returned message, which is used to describe the operation result or status information.

status

String

Returned status, which indicates whether the operation is successful. For example, 200 indicates that the operation is successful, and 400 indicates that the request is invalid.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which uniquely identifies an error type.

error_msg

String

Error information, which describes the error details.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which uniquely identifies an error type.

error_msg

String

Error information, which describes the error details.

Example Requests

Stop a scan task.

POST /v1/{project_id}/sdg/scan/job/task/{task_id}/stop

Example Responses

Status code: 400

Invalid request.

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status code: 403

Request denied.

{
  "error_code" : "dsc.50000014",
  "error_msg" : "Repeat purchase"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request.

403

Request denied.

Error Codes

See Error Codes.