首页数据安全中心数据安全中心（敏感数据保护）开发参考API参考指南API目录数据识别DescribeDataObjectColumnDetail - 查询数据对象列详情
输入文档关键字查找

DescribeDataObjectColumnDetail - 查询数据对象列详情

更新时间：2025-02-27 03:05
产品详情
社区

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

接口说明

注意事项

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
Langstring否

请求和接收消息的语言类型，默认为zh_cn。取值：

  • zh_cn：中文。
  • en_us：英文。
zh_cn
PageSizeinteger否

分页查询时，设置列表中每页显示的数据资产实例的最大条数。默认值：10。

10
CurrentPageinteger否

分页查询时，设置当前页面的页码。默认值：1。

1
ProductIdlong否

数据对象所属的产品名称对应的 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
Idlong否

设置要查询的数据对象的唯一标识 ID。

说明
您可以通过调用 DescribeDataObjects 获取标识 ID。
318248
TemplateIdlong否

行业模版 ID。

说明
您可以通过调用 DescribeDataObjects 获取行业模板标识 ID。
1
FeatureTypeinteger否

该参数已废弃。

2

返回参数

名称类型描述示例值
名称类型描述示例值
object
CurrentPageinteger

分页查询时，设置当前页面的页码。默认值：1。

1
RequestIdstring

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

8C8036CC-961D-514E-88E8-3088B5A50CA9
PageSizeinteger

分页查询时，设置列表中每页显示的数据资产实例的最大条数。默认值：10。

10
TotalCountinteger

结果中数据的总条数。

61
Itemsarray<object>

数据表的列的识别结果列表。

Ruleobject

数据表的列的识别结果对象。

ColumnNamestring

列名称。

hide14
DataTypestring

列的数据类型。

varchar
ColumnCommentstring

列的备注。

column comment
PrimaryKeyboolean

列是否为主键，取值说明：

  • true：主键。
  • false：非主键。
true
Idstring

列对象的唯一标识 ID。

1509415150052786176
RiskLevelIdlong

风险等级 ID。取值：

  • 1：N/A：未识别到敏感数据。
  • 2：S1：1 级敏感数据。
  • 3：S2：2 级敏感数据。
  • 4：S3：3 级敏感数据。
  • 5：S4：4 级敏感数据。
2
RiskLevelNamestring

风险等级名称。取值：

  • N/A：未识别到敏感数据。
  • S1：1 级敏感数据。
  • S2：2 级敏感数据。
  • S3：3 级敏感数据。
  • S4：4 级敏感数据。
S1
RuleIdlong

命中的识别模型 ID。

1004
RuleNamestring

命中的识别模型名称。

name
Categoriesarray

敏感数据所数据的行业分类列表。

Categorystring

敏感数据所数据的行业分类，多个通过逗号分隔。

general sensitive information
ModelTagsarray<object>

数据标签列表。

modelTagsobject

数据标签对象。

Idlong

数据标签名称对应的 ID。取值：

  • 101：个人敏感信息
  • 102：个人信息
  • 107：通用信息
101
Namestring

数据标签名称。取值：

  • 101：个人敏感信息
  • 102：个人信息
  • 107：通用信息
personal sensitive information
EngineTypestring

引擎类型，取值：

  • MySQL 。
  • MariaDB 。
  • Oracle 。
  • PostgreSQL 。
  • SQLServer 。
MySQL
MaskingStatusinteger

列加密状态。取值：

  • -1：未加密

  • 1：加密成功

  • 2：加密失败

-1
InstanceNamestring

数据资产表的实例名称。

rm-1234
TableNamestring

表名称。

it_table
RegionIdstring

资产所在的地域。

cn-hangzhou
ProductIdlong

数据对象所属的产品名称对应的 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
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2024-03-25OpenAPI 入参发生变更查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
2023-12-06API 内部配置变更，不影响调用查看变更详情
上一篇：DescribeDataObjects - 查询数据对象列表下一篇：DescribeDataObjectColumnDetailV2 - 查询数据对象列详情V2
  • 本页导读 （1）
  • 接口说明
  • 注意事项
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈