文档

ListSensitiveColumns - 搜索敏感字段列表

更新时间:

调用ListSensitiveColumns搜索敏感字段列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListSensitiveColumnsList
  • 全部资源
    *

请求参数

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

租户 ID。

说明 鼠标移动到界面右上角的头像处,查看租户 ID。具体操作,请参见查看租户信息
3
SchemaNamestring

数据库名,可通过调用接口 SearchDatabase 获取该参数的值。

说明 您也可以通过调用接口 ListDatabases 获取物理库的 SchemaName 值,调用接口 ListLogicDatabases 获取逻辑库的 SchemaName 值。
test_schema
TableNamestring

表名,可通过调用接口 ListTables 获取该参数的值。

test_table
ColumnNamestring

字段名,可通过调用接口 ListColumns 获取该参数的值。

test_column
SecurityLevelstring

字段敏感等级,取值如下:

  • SENSITIVE: 中敏感
  • CONFIDENTIAL: 高敏感
SENSITIVE
PageNumberinteger

第几页。

1
PageSizeinteger

每页数据量。

100
DbIdlong

数据库 ID(DatabaseId),可通过调用接口 SearchDatabase 获取该参数的值。

说明 您也可以通过调用接口 ListDatabases 获取物理库 ID 的值,调用接口 ListLogicDatabases 获取逻辑库 ID 的值。
1860
Logicboolean

是否为逻辑库,取值:

  • true:逻辑库
  • false:物理库
false

返回参数

名称类型描述示例值
object
TotalCountlong

数据总数。

1
RequestIdstring

请求 ID。

09D82FD7-F87F-59EF-AA82-AEF71B09E306
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
SensitiveColumnListobject []

敏感字段列表。

ColumnNamestring

字段名。

test_column
TableNamestring

表名。

test_table
SecurityLevelstring

字段敏感等级,返回值如下:

  • SENSITIVE: 敏感
  • CONFIDENTIAL: 机密
SENSITIVE
ColumnCountlong

敏感字段个数。

1
SchemaNamestring

数据库名。

test_schema
FunctionTypestring

脱敏算法类型,返回值如下:

  • DEFAULT:全遮掩(默认)
  • FIX_POS:固定位置
  • FIX_CHAR:固定字符
DEFAULT
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "09D82FD7-F87F-59EF-AA82-AEF71B09E306",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "ColumnName": "test_column",
        "TableName": "test_table",
        "SecurityLevel": "SENSITIVE",
        "ColumnCount": 1,
        "SchemaName": "test_schema",
        "FunctionType": "DEFAULT"
      }
    ]
  },
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈