调用DescribeDataObjectColumnDetail查询数据对象列详情_数据安全中心(DSC)-阿里云帮助中心

调用本接口查询数据表的列识别结果。

接口说明

注意事项

DescribeDataObjectColumnDetail 接口已修订为 DescribeDataObjectColumnDetailV2。建议您在开发应用程序时使用较新的版本 DescribeDataObjectColumnDetailV2。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sddp:DescribeDataObjectColumnDetail

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型，默认为zh_cn。取值： zh_cn：中文。 en_us：英文。	zh_cn
PageSize	integer	否	分页查询时，设置列表中每页显示的数据资产实例的最大条数。默认值：10。	10
CurrentPage	integer	否	分页查询时，设置当前页面的页码。默认值：1。	1
ProductId	integer	否	数据对象所属的产品名称对应的 ID。取值： 1：MaxCompute 2：OSS 3：ADB-MYSQL 4：TableStore 5：RDS 6：SELF_DB 7：PolarDB-X 8：PolarDB 9：ADB-PG 10：OceanBase 11：MongoDB 25：Redis	5
Id	integer	否	设置要查询的数据对象的唯一标识 ID。说明您可以通过调用 DescribeDataObjects 获取标识 ID。	318248
TemplateId	integer	否	行业模版 ID。说明您可以通过调用 DescribeDataObjects 获取行业模板标识 ID。	1
FeatureType	integer	否	该参数已废弃。	2

返回参数

名称	类型	描述	示例值
	object
CurrentPage	integer	分页查询时，设置当前页面的页码。默认值：1。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	8C8036CC-961D-514E-88E8-3088B5A50CA9
PageSize	integer	分页查询时，设置列表中每页显示的数据资产实例的最大条数。默认值：10。	10
TotalCount	integer	结果中数据的总条数。	61
Items	array<object>	数据表的列的识别结果列表。
	object	数据表的列的识别结果对象。
ColumnName	string	列名称。	hide14
DataType	string	列的数据类型。	varchar
ColumnComment	string	列的备注。	column comment
PrimaryKey	boolean	列是否为主键，取值说明： true：主键。 false：非主键。	true
Id	string	列对象的唯一标识 ID。	1509415150052786176
RiskLevelId	integer	风险等级 ID。取值： 1：N/A：未识别到敏感数据。 2：S1：1 级敏感数据。 3：S2：2 级敏感数据。 4：S3：3 级敏感数据。 5：S4：4 级敏感数据。	2
RiskLevelName	string	风险等级名称。取值： N/A：未识别到敏感数据。 S1：1 级敏感数据。 S2：2 级敏感数据。 S3：3 级敏感数据。 S4：4 级敏感数据。	S1
RuleId	integer	命中的识别模型 ID。	1004
RuleName	string	命中的识别模型名称。	name
Categories	array	敏感数据所数据的行业分类列表。
	string	敏感数据所数据的行业分类，多个通过逗号分隔。	general sensitive information
ModelTags	array<object>	数据标签列表。
	object	数据标签对象。
Id	integer	数据标签名称对应的 ID。取值： 101：个人敏感信息 102：个人信息 107：通用信息	101
Name	string	数据标签名称。取值： 101：个人敏感信息 102：个人信息 107：通用信息	personal sensitive information
EngineType	string	引擎类型，取值： MySQL 。 MariaDB 。 Oracle 。 PostgreSQL 。 SQLServer 。	MySQL
MaskingStatus	integer	列加密状态。取值： -1：未加密 1：加密成功 2：加密失败	-1
InstanceName	string	数据资产表的实例名称。	rm-1234
TableName	string	表名称。	it_table
RegionId	string	资产所在的地域。	cn-hangzhou
ProductId	integer	数据对象所属的产品名称对应的 ID。取值： 1：MaxCompute 2：OSS 3：ADB-MYSQL 4：TableStore 5：RDS 6：SELF_DB 7：PolarDB-X 8：PolarDB 9：ADB-PG 10：OceanBase 11：MongoDB 25：Redis	5

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "8C8036CC-961D-514E-88E8-3088B5A50CA9",
  "PageSize": 10,
  "TotalCount": 61,
  "Items": [
    {
      "ColumnName": "hide14",
      "DataType": "varchar",
      "ColumnComment": "column comment",
      "PrimaryKey": true,
      "Id": "1509415150052786176",
      "RiskLevelId": 2,
      "RiskLevelName": "S1",
      "RuleId": 1004,
      "RuleName": "name",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "InstanceName": "rm-1234",
      "TableName": "it_table",
      "RegionId": "cn-hangzhou",
      "ProductId": 5
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。