Queries the list of databases.

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 ListMetaDB

The operation that you want to perform.
DataSourceType String Required emr

The data type. Valid values: MaxCompute and E-MapReduce.
ProjectId Long Yes 123

The ID of the DataWorks workspace.
RegionId String Required cn-shanghai

The ID of the region where the event occurred.

Response parameters

Parameter Type Example Description
DatabaseInfo Struct

The information about the database.
DbList Array of DbList

The list of databases.
CreateTimeStamp Long 123434

The time when the database was created.
Location String hdfs://

The address where the database is stored.
ModifiedTimeStamp Long 1234343

The time when the database was updated.
Name String name

The name of the database.
OwnerId String 1232

The ID of the project Owner.
Type String HIVE

The type of the database instance.
UUID String 32342

The unique identifier of the database.
TotalCount Long 10

The total number of databases.
RequestId String abc

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListMetaDB
&DataSourceType=emr
&ProjectId=123
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format 

<RequestId>abc</RequestId>
<DatabaseInfo>
    <TotalCount>10</TotalCount>
    <DbList>
        <Type>HIVE</Type>
        <OwnerId>1232</OwnerId>
        <ModifiedTimeStamp>1234343</ModifiedTimeStamp>
        <UUID>32342</UUID>
        <CreateTimeStamp>123434</CreateTimeStamp>
        <Name>name</Name>
        <Location>hdfs://</Location>
    </DbList>
</DatabaseInfo>

JSON format 

{
    "RequestId": "abc",
    "DatabaseInfo": {
        "TotalCount": 10,
        "DbList": {
            "Type": "HIVE",
            "OwnerId": 1232,
            "ModifiedTimeStamp": 1234343,
            "UUID": 32342,
            "CreateTimeStamp": 123434,
            "Name": "name",
            "Location": "hdfs://"
        }
    }
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly 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 for 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 the 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 get compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The interface network 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 of the tenants.
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. Bad Guid information.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the App parameter is 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.