调用ListSensitiveColumnsDetail获取敏感字段详情-数据管理 DMS-阿里云-阿里云帮助中心

调用ListSensitiveColumnsDetail获取敏感字段详情信息。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListSensitiveColumnsDetail	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3***
SchemaName	string	是	数据库名，可通过调用接口 ListSensitiveColumns 获取该参数的值。说明物理库名：您还可以通过调用接口 ListDatabases 或 SearchDatabase 获取该参数的值。逻辑库名：您还可以通过调用接口 ListLogicDatabases 或 SearchDatabase 获取该参数的值。	SchemaName_test
TableName	string	是	表名，可通过调用接口 ListSensitiveColumns 获取该参数的值。说明您也可以通过调用接口 ListTables 获取该参数的值。	test
ColumnName	string	是	字段名，可通过调用接口 ListSensitiveColumns 获取该参数的值。说明您也可以通过调用接口 ListColumns 获取该参数的值。	ColumnName_test
DbId	long	否	数据库 ID（DatabaseId），数据库分为物理库和逻辑库两种：物理库 ID：可通过调用接口 ListDatabases 或 SearchDatabase 获取该参数的值。逻辑库 ID：可通过调用接口 ListLogicDatabases 或 SearchDatabase 获取该参数的值。	1860****
Logic	boolean	否	是否为逻辑库，取值如下： true：逻辑库 false：物理库	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7629888F-C9FB-4D16-A7D3-B443FE06FBD4
SensitiveColumnsDetailList	array<object>	敏感字段详情列表。
SensitiveColumnsDetail	object	敏感字段详情。
DbId	long	数据库 ID。	1860****
ColumnName	string	字段名。	ColumnName_test
ColumnDescription	string	字段描述。	test
TableName	string	表名。	test
DbType	string	数据库类型。	mysql
ColumnType	string	字段类型。	varchar(32)
Logic	boolean	是否为逻辑库，返回值如下： true：是 false：否	false
SchemaName	string	数据库名。	SchemaName_test
SearchName	string	数据库搜索名。	test@xxx:3306
EnvType	string	环境类型。	product
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "7629888F-C9FB-4D16-A7D3-B443FE06FBD4",
  "SensitiveColumnsDetailList": {
    "SensitiveColumnsDetail": [
      {
        "DbId": 0,
        "ColumnName": "ColumnName_test",
        "ColumnDescription": "test",
        "TableName": "test",
        "DbType": "mysql",
        "ColumnType": "varchar(32)",
        "Logic": false,
        "SchemaName": "SchemaName_test",
        "SearchName": "test@xxx:3306",
        "EnvType": "product"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史