调用DescribeColumns API查询数据资产表的列数据-数据安全中心-阿里云

调用DescribeColumns接口查询数据安全中心连接授权的MaxCompute、RDS等数据资产表中列的数据。

接口说明

本接口一般用于敏感数据资产信息表中列数据的查看，便于用户准确的对敏感数据进行分析。

注意事项

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

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sddp:DescribeColumns

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型，默认为zh_cn。取值： zh_cn：中文。 en_us：英文。	zh_cn
Name	string	否	搜索的关键词，支持模糊匹配。例如，输入 test，会搜索出搜索项中包含 test 的全部数据信息。	test
TableId	integer	否	MaxCompute、RDS 等资产表中的列所属的资产表唯一标识 ID。说明根据资产表的 ID 查询数据安全中心连接授权的数据资产表中列的数据，资产表 ID 可调用 DescribeTables 接口获取。	11132334
RuleId	integer	否	资产表中列数据命中的敏感数据识别规则的唯一标识 ID。说明根据资产表中列数据命中的敏感数据识别规则的 ID，查询数据安全中心连接授权的数据资产表中列的数据，敏感数据识别规则 ID 可调用 DescribeRules 接口获取。	11111
ProductCode	string	否	数据资产表中列数据所属产品名称。取值：MaxCompute、OSS、ADS、OTS、RDS等。	MaxCompute
InstanceId	integer	否	数据资产表中列数据所属的资产实例 ID。说明根据数据资产表中列数据所属的资产实例的 ID，查询数据安全中心连接授权的数据资产表中列的数据，资产实例 ID 可调用 DescribeInstances 接口获取。	1
InstanceName	string	否	数据资产表中列数据所属的资产实例名称。	rm-bp17t1htja573l5i8****
TableName	string	否	数据资产表的名称。	it_table
RuleName	string	否	数据资产表中列数据命中的敏感数据识别规则名称。	name
SensLevelName	string	否	敏感等级名。取值： N/A：未识别到敏感数据。 S1：1 级敏感数据。 S2：2 级敏感数据。 S3：3 级敏感数据。 S4：4 级敏感数据。	S2
PageSize	integer	否	列表每页显示的数据最大条数。	10
CurrentPage	integer	否	分页查询时的页码。	1
RiskLevelId	integer	否	敏感数据识别规则的风险等级 ID。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	2
TemplateRuleId	string	否	命中的模板规则 ID。说明您可以通过调用 DescribeCategoryTemplateRuleList 获取命中的模板规则 ID。	1542
EngineType	string	否	引擎类型，取值： MySQL 。 MariaDB 。 Oracle 。 PostgreSQL 。 SQLServer 。	MySQL
ProductId	string	否	数据对象所属的产品名称对应的 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
ModelTagId	string	否	数据标签。 101：个人敏感信息 102：个人信息	101
TemplateId	string	否	行业模板 ID。说明您可以通过调用 DescribeCategoryTemplateList 获取行业模板标识 ID。	5

返回参数

名称	类型	描述	示例值
	object
CurrentPage	integer	结果中显示的当前页的页码。	1
RequestId	string	结果的请求 ID。	769FB3C1-F4C9-4******
PageSize	integer	结果中每页显示数据条数。	10
TotalCount	integer	结果中数据的总条数。	12
Items	array<object>	数据资产表中列的数据。
	object
CreationTime	integer	数据资产表中列数据的创建时间毫秒数。	1536751124000
TableName	string	订正目标列所属的表名。	it_table
DataType	string	数据资产表中列数据的数据类型。	String
OdpsRiskLevelValue	integer	资产的风险等级编码。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	3
InstanceId	integer	数据资产表中列数据所属的资产实例 ID。	1
RiskLevelId	integer	数据资产表中列数据的风险等级 ID。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	2
RuleName	string	数据资产表中列数据命中的敏感数据识别规则名称。	name
RuleId	integer	数据资产表中列数据命中的敏感数据识别规则 ID。	1
Sensitive	boolean	数据资产表中列数据是否包含敏感数据。取值： true：数据资产表中列数据包含敏感数据。 false：数据资产表中列数据不包含敏感数据。	false
SensLevelName	string	敏感等级名。取值： N/A：未识别到敏感数据。 S1：1 级敏感数据。 S2：2 级敏感数据。 S3：3 级敏感数据。 S4：4 级敏感数据。	S2
InstanceName	string	数据资产表中列数据所属的资产实例名称。	rm-bp17t1htja573l5i8****
RiskLevelName	string	数据资产表中列数据的风险等级名称。取值： N/A：未识别到敏感数据。 S1：1 级敏感数据。 S2：2 级敏感数据。 S3：3 级敏感数据。 S4：4 级敏感数据。	S2
OdpsRiskLevelName	string	资产的风险等级名称。取值： N/A：未识别到敏感数据。 S1：1 级敏感数据。 S2：2 级敏感数据。 S3：3 级敏感数据。 S4：4 级敏感数据。	S3
Name	string	数据资产表中列的名称。	gxdata
TableId	integer	数据资产表中列数据所属的资产表 ID。	123
Id	string	数据资产表中列的唯一标识 ID。	268
ProductCode	string	数据资产表中列数据所属产品名称。取值：MaxCompute、OSS、ADS、OTS、RDS等。	MaxCompute
RevisionStatus	integer	订正状态。取值： 1：已订正。 0：未订正。	1
RevisionId	integer	订正记录 ID。	12
ModelTags	array<object>	命中识别模型的数据标签列表。
	object	命中识别模型的数据标签对象。
Id	integer	识别模型的数据标签 ID。 101：个人敏感信息。 102：个人信息。 103：重要数据。	101
Name	string	识别模型的数据标签名称。个人敏感信息。个人信息。重要数据。	personal sensitive data
RegionId	string	资产所在的地域。	cn-***
EngineType	string	数据库引擎类型。	MySQL
MaskingStatus	integer	列加密状态。取值： -1：未加密 1：加密成功 2：加密失败	-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

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "TableName": "it_table",
      "DataType": "String",
      "OdpsRiskLevelValue": 3,
      "InstanceId": 1,
      "RiskLevelId": 2,
      "RuleName": "name",
      "RuleId": 1,
      "Sensitive": false,
      "SensLevelName": "S2",
      "InstanceName": "rm-bp17t1htja573l5i8****",
      "RiskLevelName": "S2",
      "OdpsRiskLevelName": "S3",
      "Name": "gxdata",
      "TableId": 123,
      "Id": "268",
      "ProductCode": "MaxCompute",
      "RevisionStatus": 1,
      "RevisionId": 12,
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ],
      "RegionId": "cn-***",
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "ProductId": 5
    }
  ]
}

错误码

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

变更历史

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