DescribeInstances - 查询数据资产实例列表

获取SDDP连接授权的MaxCompute、RDS、OSS数据资产实例列表

接口说明

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

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

  • zh_cn:中文(简体)
  • en_us:英文(美国)
zh_cn
Namestring

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

data
ProductIdLong

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

1
RiskLevelIdLong

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

  • 1:表示未识别到敏感数据,无风险。
  • 2:表示1级敏感数据风险。
  • 3:表示2级敏感数据风险。
  • 4:表示3级敏感数据风险。
  • 5:表示4级敏感数据风险。
  • 6:表示5级敏感数据风险。
  • 7:表示6级敏感数据风险。
  • 8:表示7级敏感数据风险。
  • 9:表示8级敏感数据风险。
  • 10:表示9级敏感数据风险。
  • 11:表示10级敏感数据风险。
2
RuleIdLong

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

1111111
ServiceRegionIdstring

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

cn-hangzhou
FeatureTypeinteger

此参数已废弃。

1
ProductCodestring

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

RDS
PageSizeinteger

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

10
CurrentPageinteger

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

1

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

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

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页面的页码。

1
RequestIdstring

结果的请求ID。

71064826-726F-4ADA-B879-05D8055476FB
PageSizeinteger

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

10
TotalCountinteger

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

231
Itemsarray

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

object
CreationTimeLong

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

1637226782000
LastFinishTimeLong

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

1637622793000
Ownerstring

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

dtdep-239-******
TenantNamestring

租户的名称。

租户1
Protectionboolean

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

  • true:防护中
  • false:未防护
false
DepartNamestring

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

***DemoCenter
Labelsecboolean

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

  • true:安全
  • false:非安全
true
RiskLevelIdLong

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

  • 1:表示未识别到敏感数据,无风险。
  • 2:表示1级敏感数据风险。
  • 3:表示2级敏感数据风险。
  • 4:表示3级敏感数据风险。
  • 5:表示4级敏感数据风险。
  • 6:表示5级敏感数据风险。
  • 7:表示6级敏感数据风险。
  • 8:表示7级敏感数据风险。
  • 9:表示8级敏感数据风险。
  • 10:表示9级敏感数据风险。
  • 11:表示10级敏感数据风险。
2
ProductIdstring

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

5
Namestring

数据资产实例的名称。

gxdata
TotalCountinteger

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

231
InstanceDescriptionstring

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

实例信息1
RuleNamestring

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

***规则
Sensitiveboolean

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

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

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

1级敏感数据风险
OdpsRiskLevelNamestring

此参数已废弃。

1
SensitiveCountinteger

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

123
IdLong

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

11111
ProductCodestring

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

RDS

示例

正常返回示例

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"
        }
    ]
}

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>

错误码

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

变更历史

变更时间变更内容概要操作
2021-10-26 OpenAPI DescribeInstances 已下线
变更项变更内容
阿里云首页 数据安全中心 相关技术圈