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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeColumns

系统规定参数。取值：DescribeColumns。

Lang String 否 zh

请求和接收消息的语言类型。取值：

  • zh：中文
  • en：英文

默认取值为zh。

Name String 否 test

搜索的关键词，支持模糊匹配。

例如，输入test，会搜索出搜索项中包含test的全部数据信息。

TableId Long 否 11132334

MaxCompute、RDS等资产表中的列所属的资产表唯一标识ID。

说明 根据资产表的ID查询数据安全中心连接授权的数据资产表中列的数据，资产表ID可调用DescribeTables接口获取。
RuleId Long 否 11111

资产表中列数据命中的敏感数据识别规则的唯一标识ID。

说明 根据资产表中列数据命中的敏感数据识别规则的ID，查询数据安全中心连接授权的数据资产表中列的数据，敏感数据识别规则ID可调用DescribeRules接口获取。
ProductCode String 否 MaxCompute

数据资产表中列数据所属产品名称。例如，MaxCompute、OSS、RDS。
InstanceId Long 否 1

数据资产表中列数据所属的资产实例ID。

说明 根据数据资产表中列数据所属的资产实例的ID，查询数据安全中心连接授权的数据资产表中列的数据，资产实例ID可调用DescribeInstances接口获取。
InstanceName String 否 rm-bp17t1htja573l5i8****

数据资产表中列数据所属的资产实例名称。
TableName String 否 it_table

数据资产表的名称。
RuleName String 否 身份证（中国内地）

数据资产表中列数据命中的敏感数据识别规则名称。
SensLevelName String 否 S2

敏感等级名。取值：

  • S1：弱风险等级。
  • S2：中等风险等级。
  • S3：高级风险等级。
  • S4：最高风险等级。
PageSize Integer 否 10

列表每页显示的数据最大条数。
CurrentPage Integer 否 1

分页查询时的页码。
RiskLevelId Long 否 2

敏感数据识别规则的风险等级ID。取值：

  • 1：S1，弱风险等级。
  • 2：S2，中等风险等级。
  • 3：S3，高级风险等级。
  • 4：S4，最高风险等级。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
CurrentPage Integer 1

结果中显示的当前页的页码。
Items Array of Column

数据资产表中列的数据。
CreationTime Long 1536751124000

数据资产表中列数据的创建时间毫秒数。
DataType String String

数据资产表中列数据的数据类型。
Id String 268

数据资产表中列的唯一标识ID。
InstanceId Long 1

数据资产表中列数据所属的资产实例ID。
InstanceName String rm-bp17t1htja573l5i8****

数据资产表中列数据所属的资产实例名称。
Name String gxdata

数据资产表中列的名称。
OdpsRiskLevelName String S3

资产的风险等级名称。取值：

  • S1：弱风险等级
  • S2：中等风险等级
  • S3：高级风险等级
  • S4：最高风险等级
OdpsRiskLevelValue Integer 3

资产的风险等级编码。取值：

  • 1：S1
  • 2：S2
  • 3：S3
  • 4：S4
ProductCode String MaxCompute

数据资产表中列数据所属产品名称。例如，MaxCompute、OSS、RDS。
RevisionId Long 12

订正记录ID。
RevisionStatus Long 1

订正状态。取值：

  • 1：已订正
  • 0：未订正
RiskLevelId Long 2

数据资产表中列数据的风险等级ID。取值：

  • 1：S1
  • 2：S2
  • 3：S3
  • 4：S4
RiskLevelName String S2

数据资产表中列数据的风险等级名称。取值：

  • S1：弱风险等级
  • S2：中等风险等级
  • S3：高级风险等级
  • S4：最高风险等级
RuleId Long 1

数据资产表中列数据命中的敏感数据识别规则ID。
RuleName String **规则

数据资产表中列数据命中的敏感数据识别规则名称。
SensLevelName String S2

敏感等级名。取值：

  • S1：弱风险等级。
  • S2：中等风险等级。
  • S3：高级风险等级。
  • S4：最高风险等级。
Sensitive Boolean false

数据资产表中列数据是否包含敏感数据。取值：

  • true：数据资产表中列数据包含敏感数据。
  • false：数据资产表中列数据不包含敏感数据。
TableId Long 123

数据资产表中列数据所属的资产表ID。
TableName String it_table

订正目标列所属的表名。
PageSize Integer 10

结果中每页显示数据条数。
RequestId String 769FB3C1-F4C9-4******

结果的请求ID。
TotalCount Integer 12

结果中数据的总条数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeColumns
&<公共请求参数>

正常返回示例

XML格式 

<DescribeColumnsResponse>
	  <RequestId>769FB3C1-F4C9-4******</RequestId>
	  <TotalCount>4</TotalCount>
	  <PageSize>10</PageSize>
	  <CurrentPage>1</CurrentPage>
	  <Items>
		    <Owner>dtdep-239-***</Owner>
		    <ProductCode>RDS</ProductCode>
		    <RiskLevelId>2</RiskLevelId>
		    <RiskLevelName>S2</RiskLevelName>
		    <DepartName>***DemoCenter</DepartName>
		    <Name>gxdata</Name>
		    <CreationTime>1536751124000</CreationTime>
		    <Sensitive>true</Sensitive>
		    <Id>268</Id>
		    <RuleId>1</RuleId>
		    <RuleName>**规则</RuleName>
		    <InstanceId>1</InstanceId>
		    <TableId>123</TableId>
	  </Items>
</DescribeColumnsResponse>

JSON格式 

{
    "RequestId":"769FB3C1-F4C9-4******",
    "TotalCount":4,
    "PageSize":10,
    "CurrentPage":1,
    "Items":[
        {
            "Owner":"dtdep-239-***", 
            "ProductCode":"RDS",
            "RiskLevelId":2,
            "RiskLevelName":"S2", 
            "DepartName":"***DemoCenter", 
            "Name":"gxdata", 
            "CreationTime":1536751124000, 
            "Sensitive":true, 
            "Id":268,
            "RuleId":1,
            "RuleName":"**规则",
            "InstanceId":1,
            "TableId":123
        }
    ]
}

错误码

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