Query basic metadata of a compute engine instance with GetMetaDBInfo - DataWorks - Alibaba Cloud - DataWorks

Queries the basic metadata information about a compute engine instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AppGuid	string	No	The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.	odps.some_engine_name
ClusterId	string	No	The E-MapReduce (EMR) cluster ID.	abc
DatabaseName	string	No	The name of the metadatabase of the EMR cluster.	abc
DataSourceType	string	No	The type of the data source. Valid values: odps and emr.	emr

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0bc1411515937****
Data	object	The basic metadata information.
Type	string	The type of the metadatabase.	hive
Comment	string	The comment.	Comment
CreateTime	integer	The time when the compute engine instance was created.	1541576644000
ProjectId	integer	The workspace ID.	22
ProjectName	string	The name of the workspace.	test
AppGuid	string	The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.	odps.engine_name
OwnerName	string	The name of the workspace owner.	my_name
OwnerId	string	The ID of the Alibaba Cloud account used by the workspace owner.	userId
EnvType	integer	The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.	1
ProjectNameCn	string	The display name of the workspace.	Test project
Endpoint	string	The endpoint of the service.	http://service.odpsstg.aliyun-inc.com/
ClusterBizId	string	The EMR cluster ID.	abc
Name	string	The name of the database.	abc
Location	string	The storage path of the metadatabase of the EMR cluster.	hdfs://
TenantId	integer	The tenant ID.	233
ModifyTime	integer	The time when the compute engine instance was modified.	1541576644000

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	The MaxCompute project does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The request parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	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.	Incorrect project entered by user
400	InvalidParameter.Meta.NotExist	The data does not exist.	No data is available.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.