DescribeColumnsV2 - 查询数据资产表中列的数据V2

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sddp:DescribeColumnsV2

get

*全部资源

*

  • acs:ResourceGroupId
无

请求参数

名称

类型

必填

描述

示例值

Lang

string

否

设置请求和接收消息的语言类型,默认为zh_cn。 取值:

  • zh_cn:中文(简体)

  • en_us:英文(美国)

zh_cn

Name

string

否

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

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

test

TableId

string

否

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

说明

根据资产表的 ID 查询数据安全中心连接授权的数据资产表中列的数据,资产表 ID 可调用 DescribeTables 接口获取。

11132334

RuleId

integer

否

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

说明

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

11122200

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。

10

CurrentPage

integer

否

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

1

RiskLevelId

integer

否

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

  • 1:N/A。

  • 2:S1。

  • 3:S2。

  • 4:S3。

  • 5:S4。

2

EngineType

string

否

引擎类型,取值:

  • MySQL 。

  • MariaDB 。

  • Oracle 。

  • PostgreSQL 。

  • SQLServer 。

MySQL

返回参数

名称

类型

描述

示例值

object

CurrentPage

integer

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

1

RequestId

string

阿里云为该请求生成的唯一标识符。

B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0

PageSize

integer

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

10

TotalCount

integer

结果中数据的总条数。

12

Items

array<object>

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

array<object>

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

CreationTime

integer

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

1536751124000

TableName

string

订正目标列所属的表名。

it_table

DataType

string

数据资产表中列数据的数据类型。

varchar

OdpsRiskLevelValue

integer

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

  • 1:N/A。

  • 2:S1。

  • 3:S2。

  • 4:S3。

  • 5:S4。

说明

返回值<=1,代表 N/A。

3

InstanceId

integer

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

1232122

RiskLevelId

integer

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

  • 1:N/A。

  • 2:S1。

  • 3:S2。

  • 4:S3。

  • 5:S4。

说明

返回值<=1,代表 N/A。

4

RuleName

string

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

name

RuleId

integer

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

1004

Sensitive

boolean

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

  • true:数据资产表中列数据包含敏感数据。

  • false:数据资产表中列数据不包含敏感数据。

true

SensLevelName

string

敏感等级名。取值:

  • N/A:未识别到敏感数据。

  • S1:1 级敏感数据。

  • S2:2 级敏感数据。

  • S3:3 级敏感数据。

  • S4:4 级敏感数据。

S2

InstanceName

string

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

rm-1234

RiskLevelName

string

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

  • N/A:未识别到敏感数据。

  • S1:1 级敏感数据。

  • S2:2 级敏感数据。

  • S3:3 级敏感数据。

  • S4:4 级敏感数据。

S1

OdpsRiskLevelName

string

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

  • N/A:未识别到敏感数据。

  • S1:1 级敏感数据。

  • S2:2 级敏感数据。

  • S3:3 级敏感数据。

  • S4:4 级敏感数据。

S4

Name

string

数据资产表中列的名称。

obj_id

TableId

integer

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

123

Id

string

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

111111

ProductCode

string

数据资产表中列数据所属产品名称。取值:MaxCompute、OSS、ADS、OTS、RDS等。

RDS

RevisionStatus

integer

订正状态。取值:

  • 1:已订正。

  • 0:未订正。

1

RevisionId

integer

订正记录 ID。

12

ModelTags

array<object>

数据标签列表。

object

数据标签对象。

Id

integer

数据标签 ID。取值:

  • 101:个人敏感信息

  • 102:个人信息

  • 107:通用信息

101

Name

string

数据标签名称。取值:

  • 个人敏感信息

  • 个人信息

  • 通用信息

personal sensitive information

EngineType

string

引擎类型,取值:

  • MySQL 。

  • MariaDB 。

  • Oracle 。

  • PostgreSQL 。

  • SQLServer 。

MySQL

MaskingStatus

integer

列加密状态。取值:

  • -1:未加密

  • 1:加密成功

  • 2:加密失败

-1

ProductId

integer

数据资产所属的产品名称对应的 ID。取值:

  • 1:MaxCompute。

  • 2:OSS。

  • 3:ADS。

  • 4:OTS。

  • 5:RDS。

  • 6:SELF_DB。

5

RegionId

string

资产所在的地域。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "TableName": "it_table",
      "DataType": "varchar",
      "OdpsRiskLevelValue": 3,
      "InstanceId": 1232122,
      "RiskLevelId": 4,
      "RuleName": "name",
      "RuleId": 1004,
      "Sensitive": true,
      "SensLevelName": "S2",
      "InstanceName": "rm-1234",
      "RiskLevelName": "S1",
      "OdpsRiskLevelName": "S4",
      "Name": "obj_id",
      "TableId": 123,
      "Id": "111111",
      "ProductCode": "RDS",
      "RevisionStatus": 1,
      "RevisionId": 12,
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "ProductId": 5,
      "RegionId": "cn-hangzhou"
    }
  ]
}

错误码

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

变更历史

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