查询资产目录中的数据库列表 - ShowMetadataDatabases
功能介绍
该接口用于查询资产目录中的数据库列表。支持通过多种参数进行过滤和排序,返回符合条件的数据库信息。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/metadata/catalog/databases
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目唯一标识符 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| address | 否 | String | 数据库地址,用于过滤特定地址的数据库 |
| col_id | 否 | String | 分类ID,用于过滤特定分类下的数据库 |
| instance_name | 否 | String | 实例名称,用于过滤特定名称的数据库实例 |
| label_id | 否 | String | 标签ID,用于过滤特定标签的数据库 |
| limit | 否 | Integer | 返回的最大记录数,默认为50 |
| offset | 否 | Integer | 查询的起始位置,默认为0 |
| sort | 否 | String | 排序字段,用于指定结果的排序方式 |
| type_id | 否 | String | 类型ID,用于过滤特定类型的数据库 |
| user | 否 | String | 用户信息,用于过滤特定用户的数据库 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_infos | Array of CatalogInstanceInfo objects | 实例信息列表 |
| total | Integer | 总数量 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| address | String | 实例地址 |
| db_infos | Array of CatalogDbInfo objects | 数据库信息列表 |
| instance_id | String | 实例ID |
| instance_name | String | 实例名称 |
| sensitive_col_num | Integer | 敏感列数量 |
| sensitive_db_num | Integer | 敏感数据库数量 |
| sensitive_table_num | Integer | 敏感表数量 |
| user | String | 用户 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| asset_id | String | 资产ID |
| classifications | Array of strings | 分类列表 |
| color_number | Integer | 颜色编号 |
| db_id | String | 数据库ID |
| db_name | String | 数据库名称 |
| db_type | String | 数据库类型 |
| latest_scan_time | Long | 最新扫描时间(Unix时间戳) |
| sensitive_level_name | String | 敏感级别名称 |
| sensitive_table_count | Integer | 敏感表数量 |
| tags | Array of strings | 标签列表 |
| total_table_count | Integer | 总表数量 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询结果 |
| 401 | 未授权,用户未登录或令牌无效 |
| 403 | 无权限访问该资源 |
| 404 | 指定的项目不存在 |
错误码
请参见错误码。