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

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	long	创建引擎的时间。	1541576644000
ProjectId	long	工作空间 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	long	租户 ID。	233
ModifyTime	long	修改引擎的时间。	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.	数据不存在。
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.	DataWorks系统繁忙，请稍后再试。
429	Throttling.User	Your request is too frequent. Try again later.	您的请求过于频繁，请尝试放缓请求速度。
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.	未知错误。

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

变更历史

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

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