全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：GetMetaDBInfo - 获取引擎实例的基本元数据信息

    文档中心

    大数据开发治理平台 DataWorks：GetMetaDBInfo - 获取引擎实例的基本元数据信息

    更新时间：Nov 21, 2024

    该接口用于获取引擎实例的基本元数据信息。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dataworks:*get
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    AppGuidstring否

    引擎 ID，格式为引擎类型.引擎名称。

    		odps.some_engine_name
    ClusterIdstring否

    EMR 集群的 clusterId。

    		abc
    DatabaseNamestring否

    EMR 集群的数据库。

    		abc
    DataSourceTypestring否

    数据类型，包括 odps 和 emr。

    		emr

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		0bc1411515937****
    Dataobject

    基本元数据信息。

    Typestring

    数据库类型。

    		hive
    Commentstring

    备注。

    		备注
    CreateTimelong

    创建引擎的时间。

    		1541576644000
    ProjectIdlong

    工作空间 ID。

    		22
    ProjectNamestring

    工作空间的名称。

    		test
    AppGuidstring

    引擎 ID，格式为引擎类型.引擎名称。

    		odps.engine_name
    OwnerNamestring

    工作空间 Owner 的名称。

    		my_name
    OwnerIdstring

    工作空间 Owner 的云账号 ID。

    		userId
    EnvTypeinteger

    环境类型：0 表示非生产表，1 表示生产表。

    		1
    ProjectNameCnstring

    工作空间的显示名称。

    		测试项目
    Endpointstring

    服务地址 Endpoint。

    		http://service.odpsstg.aliyun-inc.com/
    ClusterBizIdstring

    emr 集群 id。

    		abc
    Namestring

    数据库名称。

    		abc
    Locationstring

    emr 数据库对应数据存储地址。

    		hdfs://
    TenantIdlong

    租户 ID。

    		233
    ModifyTimelong

    修改引擎的时间。

    		1541576644000

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0bc1411515937****",
  "Data": {
    "Type": "hive",
    "Comment": "备注",
    "CreateTime": 1541576644000,
    "ProjectId": 22,
    "ProjectName": "test",
    "AppGuid": "odps.engine_name",
    "OwnerName": "my_name",
    "OwnerId": "userId",
    "EnvType": 1,
    "ProjectNameCn": "测试项目",
    "Endpoint": "http://service.odpsstg.aliyun-inc.com/",
    "ClusterBizId": "abc",
    "Name": "abc",
    "Location": "hdfs://",
    "TenantId": 233,
    "ModifyTime": 1541576644000
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.Meta.AppNotExistThe MaxCompute project does not exist.MaxCompute项目不存在。
    400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.请求参数错误。
    400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.App参数错误。
    400InvalidParameter.Meta.IllegalDateThe date format is invalid.日期格式错误。
    400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.分页信息错误。
    400InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.用户输入的 project 不正确
    400InvalidParameter.Meta.NotExistThe data does not exist.数据不存在。
    403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.当前的用户不是任何租户的所有者。
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.接口网络不通。
    500InternalError.Meta.UnknownAn unknown error occurred while processing your request.未知错误。

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

    变更历史

    变更时间变更内容概要操作
    2023-05-12OpenAPI 错误码发生变更查看变更详情

    GetMetaDBInfo 接口的使用示例 Demo 请参见DataWorks OpenAPI 示例。