全部产品
Search
文档中心

大数据开发治理平台 DataWorks:GetSensitiveData - 获取敏感数据

更新时间:Nov 21, 2024

调用GetSensitiveData,获取租户下所有DataWorks工作空间的最新敏感数据识别结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageSizeinteger

每页返回的数据量,最大值为 1000。

1000
PageNointeger

页码数,最小值为 1。

1
Namestring

获取访问记录的条件设置。可选的参数如下:

  • dbType:数据类型。
  • instanceName:实例名称。
  • databaseName:数据库名称。
  • projectName:项目名称。
  • clusterName:集群名称。

示例获取 Hologres 中 ABC 实例的 abc 数据库的敏感数据访问记录。实际使用时,您需要根据业务使用的引擎进行配置。

[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]

返回参数

名称类型描述示例值
object

返回参数

SensitiveDataobject

返回的敏感数据信息。包括 totalCount(敏感数据总条数)和 sensDatas(敏感数据列表)。 其中 sensDatas(敏感数据列表)包括:

  • guid:租户元数据的唯一 id,例如 ODPS.ODPS 类型数据的 guid 由 project.table.column 组成。
  • sensType:敏感类型。
  • sensLevel:敏感级别。
{ "sensDatas": [ { "sensLevel": "L1", "guid": "dsg_demo.animal.dog", "sensType": "姓名" } ], "totalCount": 2171 }
RequestIdstring

请求 ID,一次请求的唯一标识。

0000-ABCD-EFG****

示例

正常返回示例

JSON格式

{
  "SensitiveData": {
    "sensDatas": [
      {
        "sensLevel": "L1",
        "guid": "dsg_demo.animal.dog",
        "sensType": "姓名"
      }
    ],
    "totalCount": 2171
  },
  "RequestId": "0000-ABCD-EFG****"
}

错误码

HTTP status code错误码错误信息描述
400Invalid.ParamThe request parameter is invalid. 请求参数错误。
403Forbidden.NoTenantThe tenant information cannot be obtained using user ID.无法获取租户的信息。
500InternalError.DQC.BizErrorAn internal error occurred.内部服务错误。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史