Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Querying the List of Sensitive Data Identification Tasks
Updated on 2025-07-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the List of Sensitive Data Identification Tasks

Function

This API is used to query the list of sensitive data identification tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/sdg/scan/job

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page.

limit

No

Integer

Page size.

content

No

String

Task name

is_new

No

Boolean

Whether the classification and grading feature is of the new version.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tasks

Array of ScanJob objects

List of identification tasks

total

Long

Total number of tasks
Table 4 ScanJob

Parameter

Type

Description

id

String

Task ID

name

String

Task name

rule_groups

Array of strings

Rule group used by a task

scan_templates

Map<String,String>

Template used by the task.

cycle

String

Task execution type

status

String

Task status

last_run_time

Long

Last execution time

create_time

Long

Task creation time

last_scan_risk

String

Risk level according to the last identification

use_nlp

Boolean

Whether NLP is used for identification

open

Boolean

Whether the task is started

topic_urn

String

SMN topic

start_time

Long

Task start time

security_level_name

String

Risk level name in the identification result.

security_level_color

Long

Risk level in the identification result.

asset_infos

Array of AssetInfo objects

Asset list.
Table 5 AssetInfo

Parameter

Type

Description

asset_id

String

Asset ID.

asset_type

String

Asset type.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Query the list of sensitive data identification tasks.

GET /v1/{project_id}/sdg/scan/job

{
  "limit" : 10,
  "offset" : 0,
  "content" : "xxxxxxxxxxxx",
  "is_new" : true
}

Example Responses

Status code: 200

Request sent.

{
  "total" : 1,
  "tasks" : [ {
    "id" : "xxxxxxxxxxxx",
    "name" : "xxxx",
    "cycle" : "xxxx",
    "status" : "FINISHED",
    "open" : true,
    "rule_groups" : [ "xxx" ],
    "scan_templates" : {
      "xxx" : "xxx"
    },
    "last_run_time" : 1712904721162,
    "create_time" : 1712022723454,
    "last_scan_risk" : "HIGH",
    "use_nlp" : false,
    "topic_urn" : "",
    "start_time" : 0,
    "security_level_name" : "L4",
    "security_level_color" : 9,
    "asset_infos" : [ {
      "asset_id" : "xxx",
      "asset_type" : "obs"
    } ]
  } ]
}

Status code: 400

Invalid request.

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

Status Codes

Status Code

Description

200

Request sent.

400

Invalid request.

Error Codes

See Error Codes.