文档

ListSensitiveColumnInfo - 获取敏感字段的脱敏算法相关信息

调用此接口可以获取到敏感字段所使用的脱敏算法ID、名称,以及字段的安全级别等信息。

调试

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

授权信息

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

请求参数

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

实例 ID。您可调用 ListInstancesGetInstance 接口获取该参数的值。

183****
SchemaNamestring

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

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

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

说明 您也可以通过调用接口 ListTables 获取该参数的值。
test_table
ColumnNamestring

字段名。您可调用接口 ListSensitiveColumns 获取该参数的值。

说明 您也可以通过调用接口 ListColumns 获取该参数的值。
test_column
PageNumberinteger

分页查询时,设置当前页面的页码。

1
PageSizeinteger

每页数据量。

100
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,用于定位日志,排查问题。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

错误码,请求异常时返回。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
SensitiveColumnListarray<object>

敏感字段详情列表。

object

字段详情。

InstanceIdinteger

实例 ID。

183****
SchemaNamestring

数据库名。

test_schema
TableNamestring

表名。

test_table
ColumnNamestring

字段名。

test_column
CategoryNamestring

分类名称。

默认分类
IsPlainboolean

标注该敏感序列的字段是否以明文展示。

False
SecurityLevelstring

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

UserSensitivityLevelstring

用户定义的敏感等级。

S1
SampleDatastring

抽样数据。

西安市
DefaultDesensitizationRuleobject

默认的脱敏算法信息。

RuleIdlong

脱敏算法 ID。

101**
RuleNamestring

脱敏算法名称。

test
SemiDesensitizationRuleListarray<object>

半脱敏算法列表。

object

半脱敏算法详情。

RuleIdlong

半脱敏算法 ID。

10***
RuleNamestring

半脱敏算法名称。

test01
Successboolean

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

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

数据总数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "InstanceId": 0,
        "SchemaName": "test_schema",
        "TableName": "test_table",
        "ColumnName": "test_column",
        "CategoryName": "默认分类",
        "IsPlain": true,
        "SecurityLevel": "低",
        "UserSensitivityLevel": "S1",
        "SampleData": "西安市",
        "DefaultDesensitizationRule": {
          "RuleId": 0,
          "RuleName": "test"
        },
        "SemiDesensitizationRuleList": {
          "SemiDesensitizationRule": [
            {
              "RuleId": 0,
              "RuleName": "test01"
            }
          ]
        }
      }
    ]
  },
  "Success": true,
  "TotalCount": 1
}

错误码

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