调用DescribeDataAssets接口查询存在敏感数据的资产列表。

调试

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

请求参数

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

系统规定参数。取值:DescribeDataAssets

Lang String zh_cn

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

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

指定要查询资产的关键词,支持模糊查询。

RiskLevels String 2

指定要查询的数据资产的风险等级,存在多个时使用英文逗号(,)隔开。

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

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

说明 如果根据数据资产命中的敏感数据识别规则来搜索数据资产,敏感数据识别规则的ID可调用DescribeRules接口获取。
RangeId Integer 1

指定要查询的数据资产类型。取值:

  • 1:MaxCompute项目
  • 2:MaxCompute表
  • 3:MaxCompute包
  • 11:分析型数据库MySQL(ADS)库
  • 12:分析型数据库MySQL(ADS)表
  • 21:OSS文件桶
  • 22:OSS Object
  • 31:表格存储实例
  • 32:表格存储表
  • 51:RDS库
  • 52:RDS表
  • 61:ECS自建数据库
  • 62:ECS自建数据表
  • 71:DRDS库
  • 72:DRDS表
  • 81:PolarDB库
  • 82:PolarDB表
  • 91:GPDB库
  • 92:GPDB表
PageSize Integer 20

指定分页查询时,每页显示的数据最大条数。默认值:20

CurrentPage Integer 1

指定分页查询时,当前页的页码。

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

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

返回数据

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

分页查询时,当前页的页码。

RequestId String 71064826-726F-4ADA-B879-05D8055476FB

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

PageSize Integer 20

分页查询时,每页最多显示的数据条数。

TotalCount Integer 1

查询到的存在敏感数据的资产总数量。

Items Array of Asset

数据资产列表。

Acl String private

OSS文件桶的ACL权限设置。

说明 只有您将请求参数RangeId配置为21,即要查询的数据资产为OSS文件桶时,该参数才会显示。
CreationTime Long 1536751124000

数据资产创建时间,单位为毫秒。

DataType String OSS_BUCKET

数据资产所属的数据类型。

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

数据资产所属者账号。

SensitiveRatio String 45%

在所有数据资产中敏感数据所占的比例。

Protection Boolean false

数据资产的防护状态,固定值:false。只有您将请求参数RangeId配置为1,即要查询的数据资产为MaxCompute项目时,该参数才会返回truefalse

  • false: 未开启数据保护机制。
  • true:开启数据保护机制。项目空间中的数据只能流入,不能流出。
Labelsec Boolean 0

数据的敏感度标记,固定值:0。只有您将请求参数RangeId配置为1,即要查询的数据资产为MaxCompute项目时,该参数才会返回0123

  • 0:不保密,Unclassified
  • 1:秘密,Confidential
  • 2:机密,Sensitive
  • 3 :高度机密,Highly Sensitive
TotalCount Integer 432

所有数据资产的数量。例如:MaxCompute中项目、包或表的总数;RDS中数据库或表的总数;OSS中文件桶或Object的总数。

RiskLevelId Long 2

数据资产的风险等级ID。风险等级ID越高,表示识别出的数据越敏感。取值:

  • 1:未识别到敏感数据,无风险
  • 2:1级敏感数据风险
  • 3:2级敏感数据风险
  • 4:3级敏感数据风险
  • 5:4级敏感数据风险
  • 6:5级敏感数据风险
  • 7:6级敏感数据风险
  • 8:7级敏感数据风险
  • 9:8级敏感数据风险
  • 10:9级敏感数据风险
  • 11:10级敏感数据风险
RuleName String ***规则

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

Sensitive Boolean true

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

  • true:包含
  • false:不包含
ObjectKey String 内部

OSS存储对象的Key值。

说明 只有您将请求参数RangeId配置为22,即要查询的数据资产为OSS Object时,该参数才会显示。
RiskLevelName String 中等风险等级

数据资产的风险等级名称。

OdpsRiskLevelName String S4

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

  • S1:弱风险等级
  • S2:中等风险等级
  • S3:高级风险等级
  • S4:最高风险等级
    说明 只有您将请求参数RangeId配置为1,即要查询的数据资产为MaxCompute项目时,该参数才会显示。
ProductId String 5

数据资产所属产品类型ID。取值:

  • 1:MaxCompute
  • 2:OSS
  • 3:ADS
  • 4:OTS
  • 5:RDS
Name String gxdata

数据资产名称。

SensitiveCount Integer 24

数据资产中敏感数据总数。例如:MaxCompute中敏感的项目、包或表的总数;RDS中敏感的数据库或表的总数;OSS中敏感的文件桶或Object的总数。

Id String 268

数据资产的唯一标识ID。

ProductCode String RDS

数据资产所属产品名称。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDataAssets
&Lang=zh_cn
&Name=test
&RiskLevels=2
&RuleId=11122200
&RangeId=1
&PageSize=20
&CurrentPage=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDataAssetsResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>71064826-726F-4ADA-B879-05D8055476FB</RequestId>
    <PageSize>20</PageSize>
    <TotalCount>1</TotalCount>
    <Items>
        <Acl>private</Acl>
        <CreationTime>1536751124000</CreationTime>
        <DataType>OSS_BUCKET</DataType>
        <Owner>dtdep-239-******</Owner>
        <SensitiveRatio>45%</SensitiveRatio>
        <Protection>false</Protection>
        <Labelsec>false</Labelsec>
        <TotalCount>432</TotalCount>
        <RiskLevelId>2</RiskLevelId>
        <RuleName>***规则</RuleName>
        <Sensitive>true</Sensitive>
        <ObjectKey>内部</ObjectKey>
        <RiskLevelName>中等风险等级</RiskLevelName>
        <OdpsRiskLevelName>S4</OdpsRiskLevelName>
        <ProductId>5</ProductId>
        <Name>gxdata</Name>
        <SensitiveCount>24</SensitiveCount>
        <Id>268</Id>
        <ProductCode>RDS</ProductCode>
    </Items>
</DescribeDataAssetsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CurrentPage" : 1,
  "RequestId" : "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize" : 20,
  "TotalCount" : 1,
  "Items" : [ {
    "Acl" : "private",
    "CreationTime" : 1536751124000,
    "DataType" : "OSS_BUCKET",
    "Owner" : "dtdep-239-******",
    "SensitiveRatio" : "45%",
    "Protection" : false,
    "Labelsec" : false,
    "TotalCount" : 432,
    "RiskLevelId" : 2,
    "RuleName" : "***规则",
    "Sensitive" : true,
    "ObjectKey" : "内部",
    "RiskLevelName" : "中等风险等级",
    "OdpsRiskLevelName" : "S4",
    "ProductId" : "5",
    "Name" : "gxdata",
    "SensitiveCount" : 24,
    "Id" : "268",
    "ProductCode" : "RDS"
  } ]
}

错误码

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