调用此接口可以获取到敏感字段所使用的脱敏算法ID、名称,以及字段的安全级别等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| dms:ListSensitiveColumnInfo | list | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| InstanceId | integer | 是 | 实例 ID。您可调用 ListInstances 或 GetInstance 接口获取该参数的值。 | 183**** | 
| SchemaName | string | 否 | 数据库名。您可调用接口 SearchDatabase 获取该参数的值。 说明 
您也可以调用接口 ListDatabases 获取物理库的 SchemaName 值,调用接口 ListLogicDatabases 获取逻辑库的 SchemaName 值。
 | test_schema | 
| TableName | string | 否 | 表名。您可通过调用接口 ListSensitiveColumns 获取该参数的值。 说明 
您也可以通过调用接口 ListTables 获取该参数的值。
 | test_table | 
| ColumnName | string | 否 | 字段名。您可调用接口 ListSensitiveColumns 获取该参数的值。 说明 
您也可以通过调用接口 ListColumns 获取该参数的值。
 | test_column | 
| PageNumber | integer | 否 | 分页查询时,设置当前页面的页码。 | 1 | 
| PageSize | integer | 否 | 每页数据量。 | 100 | 
| Tid | long | 否 | 租户的 ID。 说明 
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。
 | 3*** | 
返回参数
示例
正常返回示例
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
}错误码
访问错误中心查看更多错误码。
