Obtains the basic metadata of an engine instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required GetMetaDBInfo

The operation that you want to perform.

AppGuid String Required odps.some_engine_name

The engine ID, in the format of engine type. The name of the engine.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

ClusterId String No abc

The clusterId of the emr cluster.

DatabaseName String No abc

emr cluster database

DataSourceType String No emr

The data type. Valid values: odps and emr.

Response parameters

Parameter Type Example Description
Data Struct

Business data.

AppGuid String odps.engine_name

The engine ID, in the format of engine type. The name of the engine.

ClusterBizId String abc

The id of the emr cluster for querying emr data.

Comment String The remarks on the request.

Remarks

CreateTime Long 1541576644000

The time when the engine was created.

Endpoint String http://service.odpsstg.aliyun-inc.com/

The Endpoint of the service address.

EnvType Integer 1

Environment type: 0 indicates a non-production table, and 1 indicates a production table.

Location String hdfs://

The data storage address of the emr database. For emr scenarios

ModifyTime Long 1541576644000

The time when the engine was modified.

Name String abc

Database Name

OwnerId String 23

The Alibaba Cloud account ID of the workspace Owner.

OwnerName String 323

The name of the workspace Owner.

ProjectId Long 22

The ID of the DataWorks workspace.

ProjectName String test

The name of the workspace.

ProjectNameCn String Test project

The display name of the workspace.

TenantId Long 233

The ID of the tenant.

Type String hive

Data storage type

RequestId String 0bc1411515937****

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetMetaDBInfo
&AppGuid=odps.some_engine_name
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0bc1411515937****</RequestId>
<Data>
    <ModifyTime>1541576644000</ModifyTime>
    <Comment> remarks </Comment>
    <OwnerName>323</OwnerName>
    <ProjectName>test</ProjectName>
    <ProjectNameCn> test project </ProjectNameCn>
    <CreateTime>1541576644000</CreateTime>
    <ProjectId>22</ProjectId>
    <AppGuid>odps.engine_name</AppGuid>
    <EnvType>1</EnvType>
    <Name>abc</Name>
    <TenantId>233</TenantId>
    <Type>hive</Type>
    <Endpoint>http://service.odpsstg.aliyun-inc.com/</Endpoint>
    <OwnerId>23</OwnerId>
    <ClusterBizId>abc</ClusterBizId>
    <Location>hdfs://</Location>
</Data>

JSON format

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

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, probably because you have not activated DataWorks.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request to the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. Failed to retrieve the compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The network of the interface is disconnected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. An unknown error has occurred.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The current user is not the owner of any tenant.
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 error message returned because one or more request parameters are invalid.
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. Guid information error.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the specified App parameters are invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. Date format error.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The pagination information is incorrect.
400 InvalidParameter.Meta.NotExist The object does not exist. Data does not exist.

For a list of error codes, visit the API Error Center.