Help Center/Data Security Center/API Reference/API Description/Sensitive Data Discovery/Querying the Result of an Identification Task
Updated on 2024-03-29 GMT+08:00
View PDF

Querying the Result of an Identification Task

Function

This API is used to query the result of a specified identification task.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

job_id

Yes

String

Task ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page number

limit

No

Integer

Page size

type

No

String

Asset type

Enumeration values:

  • DATABASE

  • OBS

  • BIGDATA

start_time

No

String

Starting time (This parameter is currently unavailable)

end_time

No

String

End time (This parameter is currently unavailable)

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID

job_name

String

Task name

type

String

Asset type

db_scan_result

DbScanResult object

Result of identification tasks for databases

obs_scan_result

ObsScanResult object

Result of the identification task for OBS

es_scan_result

EsScanResult object

Result of the identification task for Elasticsearch

Table 4 DbScanResult

Parameter

Type

Description

total

Integer

Total number of results

db_scan_results

Array of DbScanResultInfo objects

Result list of identification tasks for databases

Table 5 DbScanResultInfo

Parameter

Type

Description

task_id

String

Task ID

db_name

String

Database name

table_id

String

Table ID

table_name

String

Table name

risk_level

Integer

Risk level

sensitive_data_type

Array of strings

Matched rules

match_info

Array of DbMatchInfo objects

Matched rules of table columns

Table 6 DbMatchInfo

Parameter

Type

Description

column_name

String

Column name

rule_name

String

Name of the matched rule

rule_id

String

ID of the matched rule

rule_risk_level

Integer

Risk level of the matched rule

column_line

Array of longs

Columns of risk data

Table 7 ObsScanResult

Parameter

Type

Description

total

Integer

Total number of results

db_scan_results

Array of ObsScanResultInfo objects

Result list of the identification task for OBS

Table 8 ObsScanResultInfo

Parameter

Type

Description

task_id

String

Task ID

bucket_id

String

OBS bucket ID

bucket_name

String

OBS bucket name

file_path

String

Directory

file_name

String

File name

md5

String

File MD5

risk_level

Integer

Risk level

sensitive_data_type

Array of strings

Sensitive data types

Table 9 EsScanResult

Parameter

Type

Description

total

Integer

Total number of results

db_scan_results

Array of EsScanResultInfo objects

Result list of the identification task for Elasticsearch

Table 10 EsScanResultInfo

Parameter

Type

Description

task_id

String

Task ID

index_name

String

Index name

type_id

String

Type ID

type_name

String

Type name

risk_level

Integer

Risk level

sensitive_data_type

Array of strings

Sensitive data type

match_info

Array of EsMatchInfo objects

Details of matched rules

Table 11 EsMatchInfo

Parameter

Type

Description

field_name

String

Data field name

rule_name

String

Rule name

rule_id

String

Rule ID

rule_risk_level

Integer

Risk level of the matched rule

Status code: 400

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Querying the Result of an Identification Task

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

Example Responses

Status code: 200

OK

{
  "job_id" : "xxxxxx",
  "job_name" : "xxxxxx",
  "type" : "DATABASE",
  "db_scan_result" : {
    "total" : 1,
    "db_scan_results" : [ {
      "task_id" : "xxxxxx",
      "db_name" : "xxxxxx",
      "table_id" : "xxxxxx",
      "table_name" : "student",
      "risk_level" : 6,
      "sensitive_data_type" : [ "xxxxxx", "xxxxxx" ],
      "match_info" : [ {
        "column_name" : "phone",
        "rule_name" : "xxxxxx",
        "rule_id" : "xxxxxx",
        "rule_risk_level" : 6,
        "column_line" : [ 1, 3 ]
      }, {
        "column_name" : "email",
        "rule_name" : "xxxxxx",
        "rule_id" : "xxxxxx",
        "rule_risk_level" : 1,
        "column_line" : [ 1, 3 ]
      } ]
    } ]
  },
  "obs_scan_result" : null,
  "es_scan_result" : null
}

Status code: 400

Invalid request

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

Status Codes

Status Code

Description

200

OK

400

Invalid request

Error Codes

See Error Codes.