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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListSensitiveColumns

系统规定参数。取值:ListSensitiveColumns

Tid Long 3

租户ID。

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

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

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

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

ColumnName String test_column

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

SecurityLevel String SENSITIVE

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

  • SENSITIVE: 中敏感
  • CONFIDENTIAL: 高敏感
PageNumber Integer 1

第几页。

PageSize Integer 100

每页数据量。

RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。
DbId Long 1860

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

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

是否为逻辑库,取值:

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

返回数据

名称 类型 示例值 描述
TotalCount Long 1

数据总数。

RequestId String 09D82FD7-F87F-59EF-AA82-AEF71B09E306

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

SensitiveColumnList Array of SensitiveColumn

敏感字段列表。

SensitiveColumn
ColumnName String test_column

字段名。

TableName String test_table

表名。

SecurityLevel String SENSITIVE

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

  • SENSITIVE: 敏感
  • CONFIDENTIAL: 机密
ColumnCount Long 1

敏感字段个数。

SchemaName String test_schema

数据库名。

FunctionType String DEFAULT

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

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

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

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSensitiveColumns
&Tid=3***
&SchemaName=test_schema
&TableName=test_table
&ColumnName=test_column
&SecurityLevel=SENSITIVE
&PageNumber=1
&PageSize=100
&DbId=1860****
&Logic=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSensitiveColumnsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>09D82FD7-F87F-59EF-AA82-AEF71B09E306</RequestId>
    <SensitiveColumnList>
        <ColumnName>test_column</ColumnName>
        <TableName>test_table</TableName>
        <SecurityLevel>SENSITIVE</SecurityLevel>
        <ColumnCount>1</ColumnCount>
        <SchemaName>test_schema</SchemaName>
        <FunctionType>DEFAULT</FunctionType>
    </SensitiveColumnList>
    <Success>true</Success>
</ListSensitiveColumnsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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