调用GetMetaDBInfo接口获取引擎实例的数据库元数据-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

接口说明

前置条件：调用本接口前，请先开通 DataWorks 企业版或旗舰版；未开通时服务会返回 403 Forbidden.Access。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AppGuid	string	否	引擎 ID，格式为`引擎类型.引擎名称`。	odps.some_engine_name
ClusterId	string	否	EMR 集群的 clusterId。	abc
DatabaseName	string	否	EMR 集群的数据库。	abc
DataSourceType	string	否	数据类型，包括 odps 和 emr。	emr

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0bc1411515937****
Data	object	基本元数据信息。
Type	string	数据库类型。	hive
Comment	string	备注。	备注
CreateTime	integer	创建引擎的时间。格式示例为 13 位数字，例如 `1541576644000`。	1541576644000
ProjectId	integer	工作空间 ID。	22
ProjectName	string	工作空间的名称。	test
AppGuid	string	引擎 ID，格式为`引擎类型.引擎名称`。	odps.engine_name
OwnerName	string	工作空间 Owner 的名称。	my_name
OwnerId	string	工作空间 Owner 的云账号 ID。	userId
EnvType	integer	环境类型：0 表示非生产表，1 表示生产表。	1
ProjectNameCn	string	工作空间的显示名称。	测试项目
Endpoint	string	服务地址 Endpoint。	http://service.odpsstg.aliyun-inc.com/
ClusterBizId	string	emr 集群 id。	abc
Name	string	数据库名称。	abc
Location	string	emr 数据库对应数据存储地址。	hdfs://
TenantId	integer	租户 ID。	233
ModifyTime	integer	修改引擎的时间。格式示例为 13 位数字，例如 `1541576644000`。	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	错误码	错误信息	描述
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	MaxCompute项目不存在。
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	请求参数错误。
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	App参数错误。
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	日期格式错误。
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	分页信息错误。
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	用户输入的 project 不正确
400	InvalidParameter.Meta.NotExist	The data does not exist.	数据不存在。
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	接口网络不通。
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	未知错误。
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	当前的用户不是任何租户的所有者。
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	没有权限，请授权
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

变更历史

更多信息，参考变更详情。