ListMetaDB - API| Alibaba Cloud Documentation Center

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	ListMetaDB	The operation that you want to perform.
DataSourceType	String	Yes	emr	The type of the data source. Only E-MapReduce (EMR) is supported.
ProjectId	Long	Yes	123	The ID of the DataWorks workspace. You can call the ListProjects operation to obtain the ID.
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 automatically determines the value of this parameter based on the endpoint used to call the operation.
PageNum	Integer	No	1	The number of the page to return.
PageSize	Integer	No	10	The number of entries to return on each page. Default value: 10. Maximum value: 100.

Response parameters


Parameter	Type	Example	Description
DatabaseInfo	Struct		The information of the metadatabases returned.
DbList	Array of DbList		The metadatabases returned.
CreateTimeStamp	Long	1388776825	The timestamp at which the metadatabase was created. You can convert the timestamp to the date based on the time zone that you use.
Location	String	hdfs://localhost:777/user/hadoop/test.txt	The URL of the metadatabase.
ModifiedTimeStamp	Long	1388776837	The timestamp at which the metadatabase was updated.
Name	String	name	The name of the metadatabase.
OwnerId	String	1232	The ID of the metadatabase owner.
Type	String	HIVE	The type of the metadatabase.
UUID	String	32342	The universally unique identifier (UUID) of the metadatabase.
TotalCount	Long	10	The total number of the metadatabases returned.
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>1388776837</ModifiedTimeStamp>
        <UUID>32342</UUID>
        <CreateTimeStamp>1388776825</CreateTimeStamp>
        <Name>name</Name>
        <Location>hdfs://localhost:777/user/hadoop/test.txt</Location>
    </DbList>
</DatabaseInfo>

JSON format

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

Error codes


HttpCode	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.	The error message returned because an internal system error has occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal system error has occurred. Try again later.
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 for the resource has exceeded the daily 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 in a short period of time. Try again later.
500	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 based on the specified MaxCompute project.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	The error message returned because your connection to the operation has failed.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	The error code returned because an unknown error has occurred.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The error message returned because the user is not the owner of a tenant.
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 one or more request parameters are invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The error message returned because 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 parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.	The error message returned because the data does not exist.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	The error message returned because you are not authorized to perform this operation. Activate DataWorks Enterprise Edition or Ultimate Edition.

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

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