获取各级元数据的信息 - ShowMetaInfo
功能介绍
功能介绍:获取各级元数据的信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/asset/{instance_id}/meta-info
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| instance_id | 是 | String | 参数解释: 子网ID 约束限制: 不涉及 取值范围: 1到64个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| level_one | 否 | String | 参数解释: 一级 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 不涉及 |
| level_two | 否 | String | 参数解释: 二级 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 不涉及 |
| level_three | 否 | String | 参数解释: 三级 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 不涉及 |
| type | 否 | String | 参数解释: 元数据类型 约束限制: 最大长度256字符 取值范围: 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 元数据名称 约束限制: 最大长度256字符 取值范围: 1到256个字符 默认取值: 不涉及 |
| param_name | 否 | String | 参数解释: 参数名 约束限制: 最大长度256字符 取值范围: 1到256个字符 默认取值: 不涉及 |
| target_meta_level | 否 | String | 参数解释: 目标元数据级别 约束限制: 最大长度256字符 取值范围: 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| db_infos | Array of DbInfo objects | 参数解释: 数据库信息列表 取值范围: 不涉及 |
| schema_names | Array of strings | 参数解释: 模式名称列表 取值范围: 不涉及 |
| table_names | Array of strings | 参数解释: 表名列表 取值范围: 不涉及 |
| column_names | Array of ColumnInfo objects | 参数解释: 列名列表 取值范围: 不涉及 |
| column_name | String | 参数解释: 列名 取值范围: 不涉及 |
| column_type | String | 参数解释: 列类型 取值范围: 不涉及 |
| db_id | String | 参数解释: 数据库ID 取值范围: 不涉及 |
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| db_type | String | 参数解释: 数据库类型 取值范围: |
| ins_id | String | 参数解释: 安全组ID 取值范围: 不涉及 |
| ins_name | String | 参数解释: 数据库信息名称 取值范围: 不涉及 |
| db_id | String | 参数解释: 数据库ID 取值范围: 不涉及 |
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| schema_name | String | 参数解释: 数据库信息名称 取值范围: 不涉及 |
| table_name | String | 参数解释: 数据库信息名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 列信息 取值范围: 不涉及 |
| comment | String | 参数解释: 字段注释 取值范围: 不涉及 |
| nullable | Boolean | 参数解释: 是否可为空 取值范围: true-是,false-否 |
| sql_type | Integer | 参数解释: 列信息类型 取值范围: 不涉及 |
| data_type | String | 参数解释: 列信息类型 取值范围: 不涉及 |
| length | Integer | 参数解释: 长度 取值范围: 不涉及 |
| default_value | String | 参数解释: 默认值 取值范围: 不涉及 |
| precision | Integer | 参数解释: 精度 取值范围: 不涉及 |
| position | Integer | 参数解释: 字段位置 取值范围: 不涉及 |
| samples | Array of strings | 参数解释: 样例 取值范围: 不涉及 |
| column_constraint_enums_list | Array of integers | 参数解释: 列约束枚举列表 取值范围: 不涉及 |
请求示例
获取各级元数据的信息
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/asset/xxxx-xxxx-xxxx-xxxx/meta-info
响应示例
状态码:200
{
"db_infos" : [ {
"db_type" : "MySQL",
"ins_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"ins_name" : "rds-instance-01",
"db_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"db_name" : "asset-db-01",
"schema_name" : "schema-resource-01",
"table_name" : "table-resource-01"
} ],
"schema_names" : [ "classification-label-01", "classification-label-02" ],
"table_names" : [ "classification-label-01", "classification-label-02" ],
"column_names" : [ {
"name" : "asset-resource-01",
"comment" : "asset-value-01",
"nullable" : true,
"sql_type" : 1,
"data_type" : "DATABASE",
"length" : 1,
"default_value" : "asset-value-01",
"precision" : 1,
"position" : 1,
"samples" : [ "sample-data-01", "sample-data-02" ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。