文档

DescribeDataObjects - 查询数据对象列表

更新时间:

调用本接口查询数据表、文件的数据识别结果。

调试

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

授权信息

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

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

请求参数

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

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

  • zh_cn:中文。
  • en_us:英文。
zh_cn
PageSizeinteger

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

10
CurrentPageinteger

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

1
ProductIdsstring

待查询的产品 ID 列表,多个用逗号分隔。取值:

  • 1:MaxCompute
  • 2:OSS
  • 3:ADB-MYSQL
  • 4:TableStore
  • 5:RDS
  • 6:SELF_DB
  • 7:PolarDB-X
  • 8:PolarDB
  • 9:ADB-PG
  • 10:OceanBase
  • 11:MongoDB
  • 25:Redis
说明 OSS 与其他产品互斥,即如果待查询中有 OSS,则不能有其他产品列表
1,5
ParentCategoryIdsstring

待查询模板的父分类列表,多个父分类 ID 用逗号分隔。

234,236,238
QueryNamestring

待查询的数据对象关键字。

t_sddp_selfmysql_pers0
ServiceRegionIdstring

资产所在的地域。取值:

  • cn-beijing:华北 2(北京)。
  • cn-zhangjiakou:华北 3(张家口)。
  • cn-huhehaote:华北 5(呼和浩特)。
  • cn-hangzhou:华东 1(杭州)。
  • cn-shanghai:华东 2(上海)。
  • cn-shenzhen:华南 1(深圳)。
  • cn-hongkong:中国香港。
cn-hangzhou
TemplateIdlong

行业模版 ID。

说明 您可以通过调用 DescribeCategoryTemplateList 获取行业模板标识 ID。
1
DomainIdlong

数据资产所属的数据域 ID。

2
ModelTagIdsstring

待查询的数据标签,多个用逗号分隔。取值:

  • 101:个人敏感信息
  • 102:个人信息
  • 107:通用信息
101,102
RiskLevelsstring

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

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

资产实例 ID 关键字。

8vb54hn2g9j191ddz
ModelIdsstring

行业模板的模型 ID,多个 ID 通过逗号分隔。

说明 您可以通过调用 DescribeTemplateAllRules 获取行业模板模型标识 ID。
101
FileTypelong

支持识别的 OSS 文件类型。

说明 您可以通过调用 DescribeDocTypes 获取支持识别的 OSS 文件类型,取返回值中的 Code 字段值,本参数仅对 OSS 类型的资产查询有效。
100001
FileCategoryCodelong

文件分类编码。

1

返回参数

名称类型描述示例值
object
CurrentPageinteger

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

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

E6F6460E-4330-549A-BD89-C183FB17571E
PageSizeinteger

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

10
TotalCountinteger

查询结果总条数。

21
Itemsobject []

数据对象列表。

Namestring

数据对象的名称。

t_sddp_selfmysql_pers0
Idstring

数据对象的唯一标识 ID。

20000
TemplateIdlong

行业模版 ID

1
ProductIdlong

数据对象所属的产品名称对应的 ID。取值:

  • 1:MaxCompute
  • 2:OSS
  • 3:ADB-MYSQL
  • 4:TableStore
  • 5:RDS
  • 6:SELF_DB
  • 7:PolarDB-X
  • 8:PolarDB
  • 9:ADB-PG
  • 10:OceanBase
  • 11:MongoDB
  • 25:Redis
5
InstanceDescriptionstring

数据对象的实例描述。

instance description
ProductCodestring

数据对象所属的产品名称。取值:

  • MaxCompute
  • OSS
  • ADB-MYSQL
  • TableStore
  • RDS
  • SELF_DB
  • PolarDB-X
  • PolarDB
  • ADB-PG
  • OceanBase
  • MongoDB
  • Redis
RDS
InstanceIdstring

数据资产实例 ID。

rm-1234
LastScanTimelong

最新扫描的时间戳,单位为毫秒。

1687676649830
SensitiveCountinteger

敏感数据数量

1
ObjectTypestring

数据对象类型。

text type
Pathstring

数据对象的路径。

rm-1234.db_test
RegionNamestring

地域名称。

cn-hangzhou
Categoriesarray

敏感数据所数据的行业分类列表。

string

敏感数据所数据的行业分类列表,多个分类通过逗号分隔。

general sensitive information
ModelTagsobject []

数据标签列表。

Idlong

数据标签 ID。取值:

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

数据标签名称。取值:

  • 个人敏感信息
  • 个人信息
  • 通用信息
personal sensitive information
RuleListobject []

命中的识别模型列表

RuleIdlong

识别模型 ID。

1080
RuleNamestring

识别模型名称。

name
RiskLevelIdlong

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

  • 1:N/A:未识别到敏感数据。
  • 2:S1:1 级敏感数据。
  • 3:S2:2 级敏感数据。
  • 4:S3:3 级敏感数据。
  • 5:S4:4 级敏感数据。
2
RiskLevelNamestring

数据资产表的风险等级名称。取值:

  • N/A:未识别到敏感数据。
  • S1:1 级敏感数据。
  • S2:2 级敏感数据。
  • S3:3 级敏感数据。
  • S4:4 级敏感数据。
S1
RuleCountinteger

命中识别模型数量。

590
ObjectFileCategorystring

文件分类名称。

text file

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "E6F6460E-4330-549A-BD89-C183FB17571E",
  "PageSize": 10,
  "TotalCount": 21,
  "Items": [
    {
      "Name": "t_sddp_selfmysql_pers0",
      "Id": "20000",
      "TemplateId": 1,
      "ProductId": 5,
      "InstanceDescription": "instance description",
      "ProductCode": "RDS",
      "InstanceId": "rm-1234",
      "LastScanTime": 1687676649830,
      "SensitiveCount": 1,
      "ObjectType": "text type",
      "Path": "rm-1234.db_test",
      "RegionName": "cn-hangzhou",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "RuleList": [
        {
          "RuleId": 1080,
          "RuleName": "name",
          "RiskLevelId": 2,
          "RiskLevelName": "S1",
          "RuleCount": 590
        }
      ],
      "ObjectFileCategory": "text file"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-25OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:FileCategoryCode
出参OpenAPI 返回结构发生变更
2023-08-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceId
    新增入参:ModelIds
    新增入参:FileType
  • 本页导读 (1)
文档反馈