DescribeTables - 查询数据资产表的数据

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

接口说明

在调用 DescribeTables 接口时,您可以设置搜索关键词、数据资产表的风险等级等参数来获取符合要求的数据资产的表信息。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

  • zh_cn:中文。
  • en_us:英文。
zh_cn
Namestring

搜索的关键词,支持模糊匹配。 例如,输入 test,会搜索出搜索项中包含 test 的全部数据信息。

test
ProductIdlong

数据资产表所属产品 ID。该产品 ID 可调用 DescribeDataAssets 接口获取。

1
ProductCodestring

数据资产表所属产品名称,包括 MaxCompute、OSS、RDS 等。关于支持的产品名称,请参见支持识别敏感数据的数据类型

MaxCompute
RiskLevelIdlong

数据资产表的风险等级 ID。 每个风险等级 ID 都有对应的风险等级名称。取值:

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

数据资产表命中的敏感数据识别规则 ID。该敏感数据识别规则 ID 可调用 DescribeRules 接口获取。

333322
InstanceIdlong

数据资产表所属的资产实例 ID。该资产实例 ID 可调用 DescribeInstances 接口获取。

1
PackageIdlong

数据资产表所属的资产包 ID。该资产包 ID 可调用 DescribePackages 接口获取。

555555
PageSizeinteger

列表中每页显示的数据最大条数。默认值:10。

10
CurrentPageinteger

分页查询时的页码。默认值:1。

1
ServiceRegionIdstring

支持数据安全中心服务的地域。更多信息,请参见支持的地域

cn-hangzhou
TemplateIdlong

行业模版 ID

1

返回参数

名称类型描述示例值
object
CurrentPageinteger

结果中显示的当前页的页码。

1
RequestIdstring

结果的请求 ID。

769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSizeinteger

结果中每页显示的数据条数。

10
TotalCountinteger

结果中数据的总条数。

13
Itemsarray<object>

数据资产表的信息列表。

Tableobject
CreationTimelong

创建该数据资产表的时间。单位:毫秒。

1536751124000
Ownerstring

拥有该数据资产表的阿里云账号。

dtdep-239-******
SensitiveRatiostring

数据资产表中敏感字段所占的百分比。

21%
TenantNamestring

租户名称。

租户1
RiskLevelIdlong

数据资产表的风险等级 ID。 每个风险等级 ID 都有对应的风险等级名称。取值:

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

数据资产表的实例名称。

实例1
ProductIdstring

数据资产表所属的产品 ID。

1
Namestring

数据资产表的名称。

gxdata
InstanceIdlong

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

1
TotalCountinteger

数据资产表包含的字段总数。

1234
InstanceDescriptionstring

实例的备注信息。

备注1
Sensitiveboolean

数据资产表中是否包含敏感字段。

  • true:包含。
  • false:不包含。
true
RiskLevelNamestring

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

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

数据资产表中包含的敏感字段总数。

32
Idlong

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

222
ProductCodestring

数据资产表所属产品名称,取值:MaxCompute、OSS、ADS、OTS、RDS等。关于支持的具体产品名称,请参见支持识别敏感数据的数据类型

MaxCompute
RuleListarray<object>

数据资产表命中的敏感数据识别规则信息。

Ruleobject
Namestring

规则的名称。

规则名称
RiskLevelIdlong

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

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

规则的总数。

12

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 10,
  "TotalCount": 13,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "Owner": "dtdep-239-******",
      "SensitiveRatio": "21%",
      "TenantName": "租户1",
      "RiskLevelId": 2,
      "InstanceName": "实例1",
      "ProductId": "1",
      "Name": "gxdata",
      "InstanceId": 1,
      "TotalCount": 1234,
      "InstanceDescription": "备注1",
      "Sensitive": true,
      "RiskLevelName": "S2",
      "SensitiveCount": 32,
      "Id": 222,
      "ProductCode": "MaxCompute",
      "RuleList": [
        {
          "Name": "规则名称",
          "RiskLevelId": 1,
          "Count": 12
        }
      ]
    }
  ]
}

错误码

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

变更历史

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