AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeDataObjects - 查询数据对象列表

更新时间：
复制为 MD 格式
产品详情
我的收藏

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

接口说明

本接口用于查询数据表、文件的识别结果，便于从全局视角查询资产的数据识别结果。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sddp:DescribeDataObjects

get

*全部资源

*
  • acs:ResourceGroupId
 无

请求参数

名称

类型

必填

描述

示例值
Lang

string

否

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

  • zh_cn：中文。

  • en_us：英文。

zh_cn
PageSize

integer

否

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

10
CurrentPage

integer

否

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

1
ProductIds

string

否

建议填写，待查询的产品 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，则不能有其他产品列表；默认查询的为非 OSS 产品。

1,5
ParentCategoryIds

string

否

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

234,236,238
QueryName

string

否

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

t_sddp_selfmysql_pers0
ServiceRegionId

string

否

资产所在的地域。取值：

  • cn-beijing：华北 2（北京）。

  • cn-zhangjiakou：华北 3（张家口）。

  • cn-huhehaote：华北 5（呼和浩特）。

  • cn-hangzhou：华东 1（杭州）。

  • cn-shanghai：华东 2（上海）。

  • cn-shenzhen：华南 1（深圳）。

  • cn-hongkong：中国香港。

cn-hangzhou
TemplateId

integer

是

行业模版 ID。

说明

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

1
DomainId

integer

否

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

2
ModelTagIds

string

否

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

  • 101：个人敏感信息。

  • 102：个人信息。

  • 107：通用信息。

101,102
RiskLevels

string

否

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

  • 2：S1，弱风险等级。

  • 3：S2，中等风险等级。

  • 4：S3，高风险等级。

  • 5：S4，最高风险等级。

2
InstanceId

string

否

资产实例 ID 关键字。

8vb54hn2g9j191ddz
ModelIds

string

否

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

说明

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

101
FileType

integer

否

支持识别的 OSS 文件类型。

说明

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

100001
FileCategoryCode

integer

否

文件分类编码。

1
MemberAccount

integer

否

成员账号 ID。

**********8103
FeatureType

integer

否

此参数已废弃。

2
APIVersion

integer

否

使用这个来进行灰度判断

1
RegionId

string

否

数据目录展示页的区域

cn-zhangjiakou
ProductId

integer

否

数据目录的产品

5
RuleIds

string

否

规则筛选

1,2,3
RiskLevelIdList

string

否

分级筛选

1,2,3
TableName

string

否

任务名筛选

TableName
DbName

string

否

数据库名筛选

dataBaseName
TaskId

integer

否

任务 Id 筛选

1
Bucket

string

否

oss 的桶筛选

bucketName
Project

string

否

SLS 的 project 筛选

project
LogStore

string

否

sls 的 logstore 筛选

logstore
LogStoreFlag

integer

否

数据目录的 sls 页面有两层，需要用这个进行判断，是查找的 logstore 维度数据

1
Path

string

否

文件路径筛选

road

返回参数

名称

类型

描述

示例值

object

CurrentPage

integer

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

1
RequestId

string

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

E6F6460E-4330-549A-BD89-C183FB17571E
PageSize

integer

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

10
TotalCount

integer

查询结果总条数。

21
Items

array<object>

数据对象列表。

array<object>

数据对象列表。

Name

string

数据对象的名称。

t_sddp_selfmysql_pers0
Id

string

数据对象的唯一标识 ID。

20000
TemplateId

integer

行业模版 ID

1
ProductId

integer

数据对象所属的产品名称对应的 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
InstanceDescription

string

数据对象的实例描述。

instance description
ProductCode

string

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

  • MaxCompute

  • OSS

  • ADB-MYSQL

  • TableStore

  • RDS

  • SELF_DB

  • PolarDB-X

  • PolarDB

  • ADB-PG

  • OceanBase

  • MongoDB

  • Redis

RDS
SensitiveCount

integer

敏感数据数量

1
ObjectType

string

数据对象类型。

text type
Path

string

数据对象的路径。

rm-12**.db_***
RegionName

string

地域名称。

cn-hangzhou
Categories

array

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

string

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

general sensitive information
ModelTags

array<object>

数据标签列表。

object

数据标签列表。

Id

integer

数据标签 ID。取值：

  • 101：个人敏感信息。

  • 102：个人信息。

  • 107：通用信息。

101
Name

string

数据标签名称。取值：

  • 个人敏感信息。

  • 个人信息。

  • 通用信息。

Personal sensitive information
RuleList

array<object>

命中的识别模型列表。

object

命中的识别模型列表。

RuleId

integer

识别模型 ID。

1080
RuleName

string

识别模型名称。

name
RiskLevelId

integer

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

  • 1：N/A：未识别到敏感数据。

  • 2：S1：1 级敏感数据。

  • 3：S2：2 级敏感数据。

  • 4：S3：3 级敏感数据。

  • 5：S4：4 级敏感数据。

2
RiskLevelName

string

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

  • N/A：未识别到敏感数据。

  • S1：1 级敏感数据。

  • S2：2 级敏感数据。

  • S3：3 级敏感数据。

  • S4：4 级敏感数据。

S1
RuleCount

integer

命中识别模型数量。

590
RuleCategoryNameList

string

从模板的最高到底部进行规则信息的描述

Personal sensitive information-ID card
SampleList

string

样例数据

["Lucy"，"Tom"]
ObjectFileCategory

string

文件分类名称。

text file
MemberAccount

integer

成员账号 ID。

**********8103
LastModifiedTime

integer

文件最新更新时间，单位为毫秒。

1687676649830
InstanceId

string

数据资产实例 ID。

rm-12*****
LastScanTime

integer

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

1687676649830
RegionId

string

数据对象所属的区域 ID。

cn-hangzhou
Comment

string

列备注

comment
DataType

string

数据库列类型

varchar
DbName

string

数据库名

DataBaseName
TableName

string

表名

tableName
RiskLevelId

integer

敏感等级

1
TaskId

integer

任务 Id

1
TaskNumber

integer

用户任务 number

1000
TaskName

string

任务名

test-task
IsRevision

integer

订正状态

-1
MaskStatus

integer

列加密状态

-1
FileCategoryCode

integer

文件类型

1
Size

integer

文件大小

1000
RuleCount

integer

命中的规则数

10
Sx

string

命中敏感等级规则的数量组成的数组，格式如下“S1,S2,S3,S4,S5,S6,S7,S8,S9,S10”，其中 S1 代表命中敏感等级为 S1 的规则数量

1,2,3,0,0,0,0,5,0,0
TemplateName

string

模板名

test
Project

string

sls 的 project

project
LogStore

string

sls 的 logStore

logStore

示例

正常返回示例

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",
      "SensitiveCount": 1,
      "ObjectType": "text type",
      "Path": "rm-12**.db_***",
      "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,
          "RuleCategoryNameList": "Personal sensitive information-ID card",
          "SampleList": "[\"Lucy\"，\"Tom\"]"
        }
      ],
      "ObjectFileCategory": "text file",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "comment",
      "DataType": "varchar",
      "DbName": "DataBaseName",
      "TableName": "tableName",
      "RiskLevelId": 1,
      "TaskId": 1,
      "TaskNumber": 1000,
      "TaskName": "test-task",
      "IsRevision": -1,
      "MaskStatus": -1,
      "FileCategoryCode": 1,
      "Size": 1000,
      "RuleCount": 10,
      "Sx": "1,2,3,0,0,0,0,5,0,0",
      "TemplateName": "test",
      "Project": "project",
      "LogStore": "logStore"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeDocTypes - 查询支持识别的OSS文件类型列表下一篇：DescribeDataObjectColumnDetail - 查询数据对象列详情