AI 助理
备案控制台
文档
输入文档关键字查找
首页 数据安全中心 数据安全中心（敏感数据保护） 开发参考 API参考指南 API目录 数据识别 DescribeInstances - 查询数据资产实例列表

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

更新时间：
产品详情
我的收藏

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

接口说明

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页面的页码。

1
RequestIdstring

结果的请求 ID。

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

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

10
TotalCountinteger

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

231
Itemsarray<object>

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

Instanceobject
CreationTimelong

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

1637226782000
LastFinishTimelong

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

1637622793000
Ownerstring

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

dtdep-239-******
TenantNamestring

租户的名称。

tenant
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

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

instance dscription
RuleNamestring

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

*** rule
Sensitiveboolean

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

  • true：包含
  • false：不包含
true
RiskLevelNamestring

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

S1
OdpsRiskLevelNamestring

此参数已废弃。

1
SensitiveCountinteger

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

123
Idlong

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

11111
ProductCodestring

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

RDS
ModelTagsarray<object>

数据标签列表。

modelTagsobject

数据标签对象。

Idlong

数据标签 ID。取值：

  • 101：个人敏感信息
  • 102：个人信息
  • 107：通用信息
101
Namestring

数据标签名称。取值：

  • 个人敏感信息
  • 个人信息
  • 通用信息
personal sensitive data

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize": 10,
  "TotalCount": 231,
  "Items": [
    {
      "CreationTime": 1637226782000,
      "LastFinishTime": 1637622793000,
      "Owner": "dtdep-239-******",
      "TenantName": "tenant",
      "Protection": false,
      "DepartName": "***DemoCenter",
      "Labelsec": true,
      "RiskLevelId": 2,
      "ProductId": "5",
      "Name": "gxdata",
      "TotalCount": 231,
      "InstanceDescription": "instance dscription",
      "RuleName": "*** rule",
      "Sensitive": true,
      "RiskLevelName": "S1",
      "OdpsRiskLevelName": "1",
      "SensitiveCount": 123,
      "Id": 11111,
      "ProductCode": "RDS",
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ],
      "MemberAliUid": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-18OpenAPI 返回结构发生变更查看变更详情
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 内部配置变更，不影响调用查看变更详情
上一篇：DescribeDataAssets - 查询数据资产敏感信息下一篇：DescribeTables - 查询数据资产表的数据
文档推荐