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

使用说明

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:DescribeTables。

Lang String zh_cn

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

  • zh_cn:中文(简体)
  • en_us:英文(美国)
Name String test

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

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

ProductId Long 1

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

ProductCode String MaxCompute

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

RiskLevelId Long 2

数据资产表的风险等级ID。

每个风险等级ID都有对应的风险等级名称。例如,风险等级ID为2表示中等风险等级。

  • 1:S1,弱风险等级。
  • 2:S2,中等风险等级。
  • 3:S3,高级风险等级。
  • 4:S4,最高风险等级。
RuleId Long 333322

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

InstanceId Long 1

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

PackageId Long 555555

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

PageSize Integer 10

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

CurrentPage Integer 1

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

ServiceRegionId String cn-hangzhou

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

返回数据

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

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

Items Array of Table

数据资产表的信息列表。

CreationTime Long 1536751124000

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

Id Long 222

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

InstanceDescription String 备注1

实例的备注信息。

InstanceId Long 1

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

InstanceName String 实例1

数据资产表的实例名称。

Name String gxdata

数据资产表的名称。

Owner String dtdep-239-******

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

ProductCode String MaxCompute

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

ProductId String 1

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

RiskLevelId Long 2

数据资产表的风险等级ID。

每个风险等级ID都有对应的风险等级名称。例如,风险等级ID为2表示中等风险等级。

  • 1:S1,弱风险等级。
  • 2:S2,中等风险等级。
  • 3:S3,高级风险等级。
  • 4:S4,最高风险等级。
RiskLevelName String 最高风险等级

数据资产表的风险等级名称。每个风险等级名称都对应一个风险等级ID,例如最高风险等级对应的风险等级ID为1。关于风险等级名称与风险等级ID的对应关系,请参见RiskLevelId参数的描述。

RuleList Array of Rule

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

Count Long 12

规则的总数。

Name String 规则名称

规则的名称。

RiskLevelId Long 1

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

每个风险等级ID都有对应的风险等级名称。风险等级ID与风险等级名称对应关系如下:

  • 1:S1,弱风险等级
  • 2:S2,中等风险等级
  • 3:S3,高级风险等级
  • 4:S4,最高风险等级
Sensitive Boolean true

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

  • true:包含
  • false:不包含
SensitiveCount Integer 32

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

SensitiveRatio String 21%

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

TenantName String 租户1

租户名称。

TotalCount Integer 1234

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

PageSize Integer 10

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

RequestId String 769FB3C1-F4C9-42DF-9B72-7077A8989C13

结果的请求ID。

TotalCount Integer 13

结果中数据的总条数。

示例

请求示例

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

正常返回示例

XML格式

<TotalCount>13</TotalCount>
<PageSize>10</PageSize>
<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>
<CurrentPage>1</CurrentPage>
<Items>
    <Owner>dtdep-239-******</Owner>
    <ProductCode>MaxCompute</ProductCode>
    <InstanceId>1</InstanceId>
    <TenantName>租户1</TenantName>
    <SensitiveRatio>21%</SensitiveRatio>
    <ProductId>1</ProductId>
    <RiskLevelId>2</RiskLevelId>
    <Name>gxdata</Name>
    <InstanceName>实例1</InstanceName>
    <TotalCount>1234</TotalCount>
    <CreationTime>1536751124000</CreationTime>
    <Sensitive>true</Sensitive>
    <RiskLevelName>最高风险等级</RiskLevelName>
    <InstanceDescription>备注1</InstanceDescription>
    <Id>222</Id>
    <SensitiveCount>32</SensitiveCount>
    <RuleList>
        <Count>12</Count>
        <RiskLevelId>1</RiskLevelId>
        <Name>规则名称</Name>
    </RuleList>
</Items>

JSON格式

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

错误码

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