查询元数据探索资产列表 - SearchMetadataList
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/{type}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| type | 是 | String | 参数解释: 元数据检索类型。 约束限制: 不涉及 取值范围: default-默认,all-所有,database-数据库,schema-数据模式,table-表,view-视图,column-列 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| keyword | 否 | String | 参数解释: 搜索关键字,按资产名称模糊匹配。 约束限制: 长度不超过255字符。 取值范围: 不涉及 默认取值: 不涉及 |
| id | 否 | String | 参数解释: 资产唯一标识,精确查询单个资产。 约束限制: UUID格式。 取值范围: 不涉及 默认取值: 不涉及 |
| classification_id | 否 | String | 参数解释: 分类标识,按分类筛选资产。 约束限制: UUID格式,多个ID以英文句号(.)分隔。 取值范围: 不涉及 默认取值: 不涉及 |
| level_id | 否 | String | 参数解释: 分级标识,按分级筛选资产。 约束限制: UUID格式。 取值范围: 不涉及 默认取值: 不涉及 |
| rule_id | 否 | String | 参数解释: 规则标识,按规则筛选资产。 约束限制: UUID格式。 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 分页大小,每页返回的资产数量。 约束限制: 取值范围1~1000。 取值范围: 1~1000 默认取值: 100 |
| offset | 否 | Integer | 参数解释: 分页偏移量,查询起始位置。 约束限制: 取值范围0~2147483647。 取值范围: 0~2147483647 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 资产总数。 取值范围: 不涉及 |
| asset_list | Array of AssetInfo objects | 参数解释: 资产列表。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| classification | ClassificationInfo object | 参数解释: 数据分类,标识数据的分类归属或安全分类 取值范围: 不涉及 |
| column_comment | String | 参数解释: 列注释 取值范围: 不涉及 |
| column_count | Integer | 参数解释: 列数量 取值范围: 不涉及 |
| columns | Array of CommonDataInfo objects | 参数解释: 列名列表,数组元素为String类型,每个元素为一个列的名称 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间 取值范围: 不涉及 |
| creator | String | 参数解释: 创建者 取值范围: 不涉及 |
| database_id | String | 参数解释: 数据库ID,标识一个数据库 取值范围: 不涉及 |
| database_name | String | 参数解释: 数据库名称,标识一个数据库 取值范围: 不涉及 |
| database_type | String | 参数解释: 数据库类型 取值范围: 不涉及 |
| database_version | String | 参数解释: 数据库版本 取值范围: 不涉及 |
| description | String | 参数解释: 描述 取值范围: 不涉及 |
| engine_type | String | 参数解释: 引擎类型 取值范围: 不涉及 |
| levels | CommonIdNameInfo object | 参数解释: 安全级别,标识数据的安全级别 取值范围: 不涉及 |
| metadata_version | String | 参数解释: 元数据版本 取值范围: 不涉及 |
| name | String | 参数解释: 名称 取值范围: 不涉及 |
| path | String | 参数解释: 路径 取值范围: 不涉及 |
| schema_id | String | 参数解释: 数据库模式ID 取值范围: 不涉及 |
| schema_name | String | 参数解释: 数据库模式名称 取值范围: 不涉及 |
| schemas | Array of CommonDataInfo objects | 参数解释: 数据库模式名称列表,数组元素为String类型,每个元素为一个数据库模式的名称 取值范围: 不涉及 |
| table_comment | String | 参数解释: 表注释 取值范围: 不涉及 |
| table_id | String | 参数解释: 表ID 取值范围: 不涉及 |
| table_name | String | 参数解释: 表名 取值范围: 不涉及 |
| table_rows | Long | 参数解释: 表行数 取值范围: 不涉及 |
| table_type | String | 参数解释: 表类型 取值范围: 不涉及 |
| tables | Array of CommonDataInfo objects | 参数解释: 表名列表,数组元素为String类型,每个元素为一张表的名称 取值范围: 不涉及 |
| tags | Array of CommonIdNameInfo objects | 参数解释: 标签名称列表,数组元素为String类型,每个元素为一个标签的名称 取值范围: 不涉及 |
| type | String | 参数解释: 元数据类型,标识资源所属的类型类别 取值范围: 不涉及 |
| update_time | Long | 参数解释: 更新时间 取值范围: 不涉及 |
| user_name | String | 参数解释: 用户名 取值范围: 不涉及 |
| views | Array of CommonDataInfo objects | 参数解释: 视图名列表,数组元素为String类型,每个元素为一个视图的名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 数据名称 取值范围: 不涉及 |
| samples | Array of strings | 参数解释: 样本列表,数组元素为String类型,每个元素为一条样本数据内容 取值范围: 不涉及 |
| classification | ClassificationInfo object | 参数解释: 分类信息 取值范围: 不涉及 |
| level | CommonIdNameInfo object | 参数解释: 通用数据信息等级 取值范围: 不涉及 |
| tags | Array of strings | 参数解释: 标签列表,数组元素为String类型,每个元素为一个标签名称 取值范围: 不涉及 |
| memo | String | 参数解释: 备注 取值范围: 不涉及 |
| description | String | 参数解释: 资源描述信息 取值范围: 不涉及 |
| col_num | Integer | 参数解释: 列的列数量,表示列信息的数量,单位:列 取值范围: 不涉及 |
| table_rows | Long | 参数解释: 表行数,表示数据表的行数量,单位:行 取值范围: 不涉及 |
| schema_name | String | 参数解释: 通用数据信息名称 取值范围: 不涉及 |
| schema_id | String | 参数解释: 通用数据信息ID 取值范围: 不涉及 |
| comment | String | 参数解释: 字段注释 取值范围: 不涉及 |
| classification_history | String | 参数解释: 分类历史记录 取值范围: 不涉及 |
| level_history | String | 参数解释: 等级历史记录 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| template_id | String | 参数解释: 模板ID 取值范围: 不涉及 |
| children | Array of CommonIdNameInfo objects | 参数解释: 子分类列表,数组元素为CommonIdNameInfo对象,包含子分类的ID和名称等信息 取值范围: 不涉及 |
请求示例
查询元数据探索资产列表,按数据库名称模糊搜索。
/v1/2b31ed5200000ebedb6e570000000000/metadata/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d
响应示例
状态码:200
{
"total" : 1,
"asset_list" : [ {
"id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"name" : "asset-demo",
"type" : "database",
"path" : "/dsc-demo/database",
"engine_type" : "mysql",
"metadata_version" : "v1",
"description" : "演示数据库资产",
"create_time" : 1710892800000,
"update_time" : 1710892800000
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。