Querying the Sensitive Data Discovery Overview Result (by Category and Security Level)

Function

This API is used to query the sensitive data discovery overview result (by category and security level).

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/sensitive-data/result/overview

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
datasource	No	String	Data Source Type Hive data source DWS Data Source DLI Data Source
cluster_name	No	String	Cluster Name
database_name	No	String	Database name
schema_name	No	String	Indicates a schema name.
table_name	No	String	Table name

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
secrecy_level_statistics	Array of SensitiveDataSecrecyLevelOverviewQueryDTO objects	Security Level-based Overview Statistics.
category_statistics	Array of SensitiveDataCategoryOverviewQueryDTO objects	Category-based overview statistics.

**Table 5** SensitiveDataSecrecyLevelOverviewQueryDTO
Parameter	Type	Description
secrecy_level_id	String	Security level ID.
secrecy_level_name	String	Security level name.
secrecy_level_number	Long	Confidentiality level.
count	Long	Number of sensitive fields at the current security level.

**Table 6** SensitiveDataCategoryOverviewQueryDTO
Parameter	Type	Description
root_id	String	Root node ID of the current classification node.
parent_id	String	Parent node ID of the current classification node.
category_id	String	Category ID.
category_name	String	Category name.
category_path	String	Category path.
count	Long	Number of sensitive fields in the current category.
children	Array of SensitiveDataCategoryOverviewQueryDTO objects	Subnode of the current classification.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

/v1/0833a5737480d53b2f25c010dc1a7b88/security/sensitive-data/result/overview

Example Responses

Status code: 200

{
  "category_statistics" : [ {
    "category_id" : "07500201b1734a459896b80a8fd7fa59",
    "category_name" : "test1",
    "category_path" : "test1",
    "children" : [ {
      "category_id" : "028c98f833d14109906a4a2a27a87547",
      "category_name" : "test5",
      "category_path" : "test1/test5",
      "children" : [ ],
      "count" : 0,
      "parent_id" : "07500201b1734a459896b80a8fd7fa59",
      "root_id" : "07500201b1734a459896b80a8fd7fa59"
    }, {
      "category_id" : "13e9eeb0d0ed4de88c1df3262f9b333c",
      "category_name" : "test3",
      "category_path" : "test1/test3",
      "children" : [ ],
      "count" : 0,
      "parent_id" : "07500201b1734a459896b80a8fd7fa59",
      "root_id" : "07500201b1734a459896b80a8fd7fa59"
    }, {
      "category_id" : "4603eaff332544e4858fa7f328ecea2a",
      "category_name" : "test6",
      "category_path" : "test1/test6",
      "children" : [ ],
      "count" : 0,
      "parent_id" : "07500201b1734a459896b80a8fd7fa59",
      "root_id" : "07500201b1734a459896b80a8fd7fa59"
    }, {
      "category_id" : "5b46ec0ffc9249b59b9bcb4db2a276bf",
      "category_name" : "test2",
      "category_path" : "test1/test2",
      "children" : [ ],
      "count" : 0,
      "parent_id" : "07500201b1734a459896b80a8fd7fa59",
      "root_id" : "07500201b1734a459896b80a8fd7fa59"
    }, {
      "category_id" : "b82cb60a51ef47d8a1585cc1f1a75612",
      "category_name" : "test4",
      "category_path" : "test1/test4",
      "children" : [ ],
      "count" : 0,
      "parent_id" : "07500201b1734a459896b80a8fd7fa59",
      "root_id" : "07500201b1734a459896b80a8fd7fa59"
    } ],
    "count" : 4,
    "parent_id" : "-1",
    "root_id" : "07500201b1734a459896b80a8fd7fa59"
  } ],
  "secrecy_level_statistics" : [ {
    "count" : 6,
    "secrecy_level_id" : "8a948048831b060101831b2ee3be0000",
    "secrecy_level_name" : "testSecrecyLevel01",
    "secrecy_level_number" : 2
  } ]
}