DescribeDataObjectColumnDetail - 查询数据对象列详情

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

接口说明

注意事项

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
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

示例

正常返回示例

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"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
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 内部配置变更,不影响调用查看变更详情