查询元数据探索详情列表数据 - ShowAssetCenterMetadataInfo
功能介绍
功能介绍:查询元数据探索详情列表数据
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/info
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页偏移量 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
| type | 否 | String | 参数解释: 元数据类型,用于按类型筛选元数据 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| classify | 否 | String | 参数解释: 元数据分类名称,用于按分类筛选元数据 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| id | 是 | String | 参数解释: 元数据资源ID,标识一条元数据记录,可通过查询元数据列表接口获取 约束限制: 合法 UUID 取值范围: 不涉及 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 资产名称,用于按名称筛选或查询数据资产 约束限制: 不涉及 取值范围: 不涉及 默认取值: '' |
| asset_type | 否 | String | 参数解释: 资产类型,标识资产的类型名称,用于按资产类型筛选元数据 约束限制: 不涉及 取值范围: 不涉及 默认取值: DATABASE |
| asset_id | 否 | String | 参数解释: 资产ID,标识一个数据资产,可通过查询资产列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: '' |
| object_full_path | 否 | String | 参数解释: 对象完整路径,用于定位OBS对象在桶中的具体位置 约束限制: 不涉及 取值范围: 不涉及 默认取值: '' |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| asset_list | Array of CommonDataInfo objects | 参数解释: 资产列表,数组元素为CommonDataInfo对象,包含资产的详细信息 取值范围: 不涉及 |
| total | Long | 参数解释: 总记录数,表示查询返回的总记录条数,单位:条 取值范围: 不涉及 |
| obj_examples | Array of ObjExamples objects | 参数解释: 对象示例列表,数组元素为ObjExamples对象,包含对象的示例数据信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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和名称等信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 资源名称,标识资源的名称 取值范围: 不涉及 |
| tag_gen_type | String | 参数解释: 标签生成类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| examples | Array of strings | 参数解释: 示例数据列表,数组元素为String类型,每个元素为一条示例数据 取值范围: 不涉及 |
| asset_name | String | 参数解释: 资产名称 取值范围: 不涉及 |
| asset_id | String | 参数解释: 资产ID 取值范围: 不涉及 |
| update_time | Long | 参数解释: 更新时间,Unix时间戳,单位:毫秒 取值范围: 不涉及 |
| obj_name | String | 参数解释: 对象名称 取值范围: 不涉及 |
| object_full_path | String | 参数解释: 对象完整路径 取值范围: 不涉及 |
请求示例
查询元数据探索详情列表数据
/v1/2b31ed5200000ebedb6e570000000000/metadata/info
响应示例
状态码:200
{
"asset_list" : [ {
"id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"name" : "asset-resource-01",
"samples" : [ "sample-data-01", "sample-data-02" ],
"classification" : {
"template_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"children" : [ {
"id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"name" : "asset-resource-01",
"tag_gen_type" : "DATABASE"
} ]
},
"level" : {
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"name" : "asset-resource-01",
"tag_gen_type" : "DATABASE"
},
"tags" : [ "classification-tag-01", "level-tag-01" ],
"memo" : "asset-value-01",
"description" : "资产中心数据资源描述",
"col_num" : 2,
"table_rows" : 1,
"schema_name" : "schema-resource-01",
"schema_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"comment" : "asset-value-01",
"classification_history" : "asset-value-01",
"level_history" : "asset-value-01"
} ],
"total" : 1,
"obj_examples" : [ {
"examples" : [ "example-data-01", "example-data-02" ],
"asset_name" : "asset-db-01",
"asset_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"update_time" : 1700000000000,
"obj_name" : "obj-resource-01",
"object_full_path" : "/v1/asset-center/resource"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。