GetSchema - 获取数据地图数据库模式信息

更新时间:
复制 MD 格式

获取数据地图中给定模式的详细信息,当前支持MaxComputeHologres类型。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

  2. 当前支持 MaxCompute 和 Hologres 类型。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Id

string

ID,可参考 ListSchemas 接口返回结果,以及元数据实体相关概念说明

格式为${EntityType}:${实例 ID 或转义后的 URL}:${数据目录标识}:${数据库名称}:${模式名称},对于不存在的层级空字符占位。

说明

对于 MaxCompute 类型,实例 ID 层级使用空字符占位,数据库名称为 MaxCompute 项目名称,且要求该项目已开启三层模型。

几种常用类型 ID 格式参考如下

maxcompute-schema:::project_name:schema_name (要求该项目已开启三层模型)

holo-schema:instance_id::database_name:schema_name

说明

其中
instance_id: holo 实例 ID
database_name: 数据库名称
project_name: MaxCompute 项目名
schema_name: schema 名称










maxcompute-schema:::project_name:schema_name

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

A89B5D9D-74EA-XXXXXX

Success

boolean

请求是否成功。

true

Schema Schema

schema 信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "A89B5D9D-74EA-XXXXXX",
  "Success": true,
  "Schema": {
    "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
    "Name": "test_db",
    "Comment": "test comment",
    "Type": "MANAGED",
    "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情