调用DescribeInstances接口获取数据安全中心连接授权的MaxCompute、RDS、OSS等数据资产实例列表。

使用说明

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:DescribeInstances

Lang String zh_cn

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

取值:

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

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

ProductId Long 1

设置数据资产实例所属产品的ID。您可以通过调用DescribeDataAssets接口获取产品ID。

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级敏感数据风险。
RuleId Long 1111111

设置数据资产实例命中的敏感数据识别规则ID。该敏感数据识别规则的ID可调用DescribeRules接口,查看返回参数Id获取。

ServiceRegionId String cn-hangzhou

设置数据资产实例的地域。更多信息,请参见支持的地域

FeatureType Integer 1

此参数已废弃。

ProductCode String RDS

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

PageSize Integer 10

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

CurrentPage Integer 1

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

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

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

返回数据

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

当前页面的页码。

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

结果的请求ID。

PageSize Integer 10

列表中每页显示的数据资产实例的数量。

TotalCount Integer 231

查询到的数据资产实例的总数量。

Items Array of Instance

查询到的数据资产实例详情。

CreationTime Long 1637226782000

创建该数据资产实例的时间。使用时间戳表示,单位:毫秒。

LastFinishTime Long 1637622793000

最近一次扫描数据资产实例的完成时间。使用时间戳表示,单位:毫秒。

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

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

TenantName String 租户1

租户的名称。

Protection Boolean false

数据资产实例的防护状态。取值:

  • true:防护中
  • false:未防护
DepartName String ***DemoCenter

数据资产实例所属部门的名称。

Labelsec Boolean true

数据资产实例的安全状态。取值:

  • true:安全
  • false:非安全
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级敏感数据风险。
ProductId String 5

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

Name String gxdata

数据资产实例的名称。

TotalCount Integer 231

数据资产实例中的数据总数。例如:当数据资产为RDS时,表示该实例中数据库的总表数。

InstanceDescription String 实例信息1

数据资产实例的描述信息。

RuleName String ***规则

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

Sensitive Boolean true

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

  • true:包含
  • false:不包含
RiskLevelName String 1级敏感数据风险

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

OdpsRiskLevelName String 1

此参数已废弃。

SensitiveCount Integer 123

数据资产实例中包含的敏感数据总数。例如:当数据资产为RDS时,表示该实例中数据库的敏感总表数。

Id Long 11111

数据安全中心服务中记录的数据资产实例的唯一标识ID。

ProductCode String RDS

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstances
&Lang=zh_cn
&Name=data
&ProductId=1
&RiskLevelId=2
&RuleId=1111111
&ServiceRegionId=cn-hangzhou
&FeatureType=1
&ProductCode=RDS
&PageSize=10
&CurrentPage=1
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstancesResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>71064826-726F-4ADA-B879-05D8055476FB</RequestId>
    <PageSize>10</PageSize>
    <TotalCount>231</TotalCount>
    <Items>
        <CreationTime>1637226782000</CreationTime>
        <LastFinishTime>1637622793000</LastFinishTime>
        <Owner>dtdep-239-******</Owner>
        <TenantName>租户1</TenantName>
        <Protection>false</Protection>
        <DepartName>***DemoCenter</DepartName>
        <Labelsec>true</Labelsec>
        <RiskLevelId>2</RiskLevelId>
        <ProductId>5</ProductId>
        <Name>gxdata</Name>
        <TotalCount>231</TotalCount>
        <InstanceDescription>实例信息1</InstanceDescription>
        <RuleName>***规则</RuleName>
        <Sensitive>true</Sensitive>
        <RiskLevelName>1级敏感数据风险</RiskLevelName>
        <OdpsRiskLevelName>1</OdpsRiskLevelName>
        <SensitiveCount>123</SensitiveCount>
        <Id>11111</Id>
        <ProductCode>RDS</ProductCode>
    </Items>
</DescribeInstancesResponse>

JSON格式

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

{
  "CurrentPage" : 1,
  "RequestId" : "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize" : 10,
  "TotalCount" : 231,
  "Items" : [ {
    "CreationTime" : 1637226782000,
    "LastFinishTime" : 1637622793000,
    "Owner" : "dtdep-239-******",
    "TenantName" : "租户1",
    "Protection" : false,
    "DepartName" : "***DemoCenter",
    "Labelsec" : true,
    "RiskLevelId" : 2,
    "ProductId" : "5",
    "Name" : "gxdata",
    "TotalCount" : 231,
    "InstanceDescription" : "实例信息1",
    "RuleName" : "***规则",
    "Sensitive" : true,
    "RiskLevelName" : "1级敏感数据风险",
    "OdpsRiskLevelName" : "1",
    "SensitiveCount" : 123,
    "Id" : 11111,
    "ProductCode" : "RDS"
  } ]
}

错误码

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