查询元数据探索信息详情 - ShowAssetCenterMetadataDetail
功能介绍
功能介绍:查询元数据探索信息详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/detail/{type}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| type | 是 | String | 参数解释: 元数据类型,用于标识所查询元数据所属的类型类别 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 元数据资源ID,标识一条元数据记录,可通过查询元数据列表接口获取 约束限制: type 为 column 时格式为 tableId:columnFqn,其中 tableId 为合法 UUID;其他类型为 [a-zA-Z0-9._-]+ 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| classification | ClassificationInfo object | 参数解释: 数据分类,标识数据的分类归属或安全分类 取值范围: 不涉及 |
| column_comment | String | 参数解释: 列注释 取值范围: 不涉及 |
| column_count | Integer | 参数解释: 列数量 取值范围: 不涉及 |
| columns | Array of CommonDataInfo objects | 参数解释: 列名列表,数组元素为String类型,每个元素为一个列的名称 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| 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 | 参数解释: 更新时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| 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/detail/database?id=2b31ed5200000ebedb6e570000000000
响应示例
状态码:200
{
"id" : "2b31ed5200000ebedb6e570000000000",
"name" : "asset-db-01",
"type" : "database",
"path" : "/mysql/asset-db-01",
"engine_type" : "MySQL",
"creator" : "asset-admin",
"database_version" : "8.0",
"metadata_version" : "1.0",
"column_count" : 10,
"table_rows" : 100,
"column_comment" : "列注释",
"table_comment" : "表注释",
"table_name" : "table-resource-01",
"table_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"database_name" : "asset-db-01",
"database_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"schema_name" : "schema-resource-01",
"schema_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"user_name" : "asset-admin",
"database_type" : "MySQL",
"table_type" : "BASE TABLE",
"description" : "数据库资产",
"create_time" : 1700000000000,
"update_time" : 1700000000000,
"tags" : [ {
"id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"name" : "env"
} ],
"classification" : {
"template_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"children" : [ {
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"name" : "个人信息"
} ]
},
"levels" : {
"id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"name" : "L3"
},
"schemas" : [ {
"id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"name" : "schema-resource-01"
} ],
"tables" : [ {
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"name" : "table-resource-01"
} ],
"columns" : [ {
"id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"name" : "column-resource-01"
} ],
"views" : [ {
"id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"name" : "view-resource-01"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。