ListMetaDB - DataWorks - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can call the ListProjects operation to query the ID.	123
DataSourceType	string	Yes	The type of the data source. Set the value to emr.	emr
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ClusterId	string	No	The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to query the ID.	abc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	abc
DatabaseInfo	object	The information about the metadatabases.
TotalCount	long	The total number of the metadatabases returned.	10
DbList	array<object>	The metadatabases.
DbList	object
Type	string	The type of the metadatabase.	HIVE
CreateTimeStamp	long	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
UUID	string	The UUID of the metadatabase.	32342
ModifiedTimeStamp	long	The timestamp at which the metadatabase was updated.	1388776837
Name	string	The name of the metadatabase.	name
OwnerId	string	The owner ID.	1232
Location	string	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 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	InvalidParameter.Meta.NotExist	The object does not exist.	-
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.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
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.

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

Change history

Change time	Summary of changes	Operation

No change history