All Products
Search
Document Center

DataWorks:ListMetaDB

Last Updated:Jan 08, 2026

Queries a list of metadatabases.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The DataWorks workspace ID. You can call the ListProjects operation to query the ID.

123
DataSourceTypestringYes

The type of the data source. Set the value to emr.

emr
PageNumintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
ClusterIdstringNo

The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to query the ID.

abc

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

abc
DatabaseInfoobject

The information about the metadatabases.

TotalCountlong

The total number of the metadatabases returned.

10
DbListarray<object>

The metadatabases.

DbListobject
Typestring

The type of the metadatabase.

HIVE
CreateTimeStamplong

The timestamp at which the metadatabase was created. You can convert the timestamp to the date based on the time zone that you use.

1388776825
UUIDstring

The UUID of the metadatabase.

32342
ModifiedTimeStamplong

The timestamp at which the metadatabase was updated.

1388776837
Namestring

The name of the metadatabase.

name
OwnerIdstring

The owner ID.

1232
Locationstring

The URL of the metadatabase.

hdfs://localhost:777/user/hadoop/test.txt

Examples

Sample success responses

JSONformat

{
  "RequestId": "abc",
  "DatabaseInfo": {
    "TotalCount": 10,
    "DbList": [
      {
        "Type": "HIVE",
        "CreateTimeStamp": 1388776825,
        "UUID": 32342,
        "ModifiedTimeStamp": 1388776837,
        "Name": "name",
        "OwnerId": 1232,
        "Location": "hdfs://localhost:777/user/hadoop/test.txt"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Meta.AppNotExistThe MaxCompute project does not exist.The MaxCompute project does not exist.
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter is invalid.
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.The app guid parameter is invalid.
400InvalidParameter.Meta.IllegalDateThe date format is invalid.The date format is invalid.
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.The parameter for paging is invalid.
400InvalidParameter.Meta.NotExistThe object does not exist.-
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-
500InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.Failed to connect to the interface network.
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.An unknown error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history