Updated on 2026-01-13 GMT+08:00

Enabling or Disabling a Task

Function

This API is used to enable or disable a sensitive data identification task.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/sdg/scan/job/{job_id}/switch-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

job_id

Yes

String

Task ID, which uniquely identifies a task.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

open

No

Boolean

Switch status.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

msg

String

Returned message

status

String

Return status, for example, '200', '400'.

Status code: 201

Created

Example Requests

PUT /v1/{project_id}/sdg/scan/job/{job_id}/switch-status

{
  "open" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

201

Created

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project does not exist.

Error Codes

See Error Codes.