文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产透视/ 查询资产目录库量级表 - ListCatalogDatabases
更新时间:2026-10-09 GMT+08:00
分享

查询资产目录库量级表 - ListCatalogDatabases

功能介绍

功能介绍:查询资产目录库量级表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/metadata/catalog/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

label_id

否

String

参数解释:

标签ID

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

type_id

否

String

参数解释:

类型ID

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

instance_name

否

String

参数解释:

资产名称

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

address

否

String

参数解释:

连接地址

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

user

否

String

参数解释:

用户

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

sort

否

String

参数解释:

排序

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

col_id

否

String

参数解释:

列ID

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

0

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

50

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

instance_infos

Array of CatalogInstanceInfo objects

参数解释:

实例信息列表

取值范围:

不涉及

表5 CatalogInstanceInfo

参数

参数类型

描述

instance_id

String

参数解释:

实例ID

取值范围:

不涉及

instance_name

String

参数解释:

实例名称

取值范围:

不涉及

address

String

参数解释:

连接地址

取值范围:

不涉及

user

String

参数解释:

用户名

取值范围:

不涉及

db_infos

Array of CatalogDbInfo objects

参数解释:

元数据信息响应体

取值范围:

不涉及

sensitive_db_num

Integer

参数解释:

敏感数据库数量

取值范围:

不涉及

sensitive_table_num

Integer

参数解释:

敏感表数量

取值范围:

不涉及

sensitive_col_num

Integer

参数解释:

敏感列数量

取值范围:

不涉及

asset_id

String

参数解释:

资产ID

取值范围:

不涉及

classification_history

String

参数解释:

分类历史

取值范围:

不涉及

classifications

Array of strings

参数解释:

分类列表

取值范围:

不涉及

color_number

Integer

参数解释:

颜色编号

取值范围:

不涉及

db_name

String

参数解释:

数据库名称

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

db_id

String

参数解释:

数据库ID

取值范围:

不涉及

latest_scan_time

Long

参数解释:

最后扫描时间

取值范围:

不涉及

level_history

String

参数解释:

级别历史

取值范围:

不涉及

sensitive_level_name

String

参数解释:

敏感级别名称

取值范围:

不涉及

sensitive_table_count

Integer

参数解释:

敏感表数量

取值范围:

不涉及

tags

Array of strings

参数解释:

标签

取值范围:

不涉及

total_table_count

Integer

参数解释:

表总数

取值范围:

不涉及

表6 CatalogDbInfo

参数

参数类型

描述

db_id

String

参数解释:

数据库ID

取值范围:

不涉及

asset_id

String

参数解释:

资产ID

取值范围:

不涉及

db_name

String

参数解释:

数据库名称

取值范围:

不涉及

total_table_count

Integer

参数解释:

目录数据库信息数量

取值范围:

不涉及

sensitive_table_count

Integer

参数解释:

敏感表数量

取值范围:

不涉及

sensitive_level_name

String

参数解释:

敏感等级名称

取值范围:

不涉及

color_number

Integer

参数解释:

颜色编号

取值范围:

不涉及

tags

Array of strings

参数解释:

标签列表

取值范围:

不涉及

classifications

Array of strings

参数解释:

分类列表

取值范围:

不涉及

latest_scan_time

Long

参数解释:

最近扫描时间

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

classification_history

String

参数解释:

分类历史记录

取值范围:

不涉及

level_history

String

参数解释:

等级历史记录

取值范围:

不涉及

请求示例

查询资产目录库量级表

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/metadata/catalog/databases

响应示例

状态码:200

{
  "total" : 1,
  "instance_infos" : [ {
    "instance_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
    "instance_name" : "instance-resource-01",
    "address" : "192.168.1.100",
    "user" : "asset-admin",
    "db_infos" : [ {
      "db_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
      "asset_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "db_name" : "asset-db-01",
      "total_table_count" : 2,
      "sensitive_table_count" : 2,
      "sensitive_level_name" : "sensitive_level-resource-01",
      "color_number" : 1,
      "tags" : [ "classification-tag-01", "level-tag-01" ],
      "classifications" : [ "classification-01", "classification-02" ],
      "latest_scan_time" : 1700000000000,
      "db_type" : "MySQL",
      "classification_history" : "asset-value-01",
      "level_history" : "asset-value-01"
    } ],
    "sensitive_db_num" : 2,
    "sensitive_table_num" : 2,
    "sensitive_col_num" : 2
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档