文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据安全API/ 敏感数据分布接口/ 查询敏感数据发现概览结果(以分类和密级为单位)
更新时间:2024-09-12 GMT+08:00
分享

查询敏感数据发现概览结果(以分类和密级为单位)

功能介绍

查询敏感数据发现概览结果(以分类和密级为单位)。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

datasource

String

数据源类型

  • HIVE数据源

  • DWS数据源

  • DLI数据源

cluster_name

String

集群名称。

database_name

String

数据库名称。

schema_name

String

schema名称。

table_name

String

表名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)使用Token认证时必选。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

secrecy_level_statistics

Array of SensitiveDataSecrecyLevelOverviewQueryDTO objects

基于密级的概览统计。

category_statistics

Array of SensitiveDataCategoryOverviewQueryDTO objects

基于分类的概览统计。

表5 SensitiveDataSecrecyLevelOverviewQueryDTO

参数

参数类型

描述

secrecy_level_id

String

密级ID。

secrecy_level_name

String

密级名称。

secrecy_level_number

Long

密级的等级。

count

Long

当前密级下的敏感字段数量。

表6 SensitiveDataCategoryOverviewQueryDTO

参数

参数类型

描述

root_id

String

当前分类节点的根节点id。

parent_id

String

当前分类节点的父节点id。

category_id

String

分类的Id。

category_name

String

分类的名称。

category_path

String

分类path。

count

Long

当前分类下的敏感字段数量。

children

Array of SensitiveDataCategoryOverviewQueryDTO objects

当前分类的子节点。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码: 200

ok

{
  "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
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListSecuritySensitiveDataOverviewsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSecuritySensitiveDataOverviewsRequest request = new ListSecuritySensitiveDataOverviewsRequest();
        try {
            ListSecuritySensitiveDataOverviewsResponse response = client.listSecuritySensitiveDataOverviews(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSecuritySensitiveDataOverviewsRequest()
        response = client.list_security_sensitive_data_overviews(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSecuritySensitiveDataOverviewsRequest{}
	response, err := client.ListSecuritySensitiveDataOverviews(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

ok

400

Bad Request

相关文档