Queries the basic metadata information about a compute engine instance.

You can call this operation to query only the basic metadata information about a MaxCompute or E-MapReduce (EMR) compute 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 Yes GetMetaDBInfo

The operation that you want to perform. Set the value to GetMetaDBInfo.

AppGuid String Yes odps.some_engine_name

The ID of the compute engine instance. Specify the ID in the Engine type.Engine name format.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.

ClusterId String No abc

The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.

You can log on to the EMR console to obtain the ID of the EMR cluster.

DatabaseName String No abc

The name of the metadatabase. This parameter is required only if you set the DataSourceType parameter to emr.

You can call the ListMetaDB operation to query the name of the metadatabase.

DataSourceType String No emr

The type of the data source. Valid values: odps and emr.

Response parameters

Parameter Type Example Description
RequestId String 0bc1411515937****

The ID of the request.

Data Object

The business data returned.

Type String hive

The type of the metadatabase.

Comment String Comment

The comment.

CreateTime Long 1541576644000

The time when the compute engine instance was created.

ProjectId Long 22

The ID of the workspace.

ProjectName String test

The name of the workspace.

AppGuid String odps.engine_name

The ID of the compute engine instance. The ID is in the Engine type.Engine name format.

OwnerName String 323

The name of the workspace owner.

OwnerId String 23

The ID of the Alibaba Cloud account used by the workspace owner.

EnvType Integer 1

The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.

ProjectNameCn String Test project

The display name of the workspace.

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

The endpoint of the service.

ClusterBizId String abc

The ID of the EMR cluster. This parameter is returned only for an EMR compute engine instance.

Name String abc

The name of the metadatabase.

Location String hdfs://

The storage path of the metadatabase of the EMR cluster.

TenantId Long 233

The ID of the tenant.

ModifyTime Long 1541576644000

The time when the compute engine instance was modified.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaDBInfo
&AppGuid=odps.some_engine_name
&ClusterId=abc
&DatabaseName=abc
&DataSourceType=emr
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0bc1411515937****",
  "Data" : {
    "Type" : "hive",
    "Comment" : "Comment",
    "CreateTime" : 1541576644000,
    "ProjectId" : 22,
    "ProjectName" : "test",
    "AppGuid" : "odps.engine_name",
    "OwnerName" : 323,
    "OwnerId" : 23,
    "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 error message returned because the MaxCompute project does not exist.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because the values specified for one or more request parameters are invalid.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the values specified for one or more parameters of the application are invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. The error message returned because the date format is invalid.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The error message returned because the value of the parameter for paging is invalid.
400 InvalidParameter.Meta.NotExist The object does not exist. The error message returned because the object you query does not exist.
400 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
400 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. The error message returned because the system has failed to obtain the compute engine instance based on the specified MaxCompute project.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The error message returned because the current user is not a tenant owner.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The error message returned because the network cannot be connected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. The error message returned because an unknown error has occurred.

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

For more information about the example on how to use the GetMetaDBInfo operation, see Examples of DataWorks API operations.