Queries metadatabases.

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. Set the value to ListMetaDB.

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.

ProjectId Long Yes 123

The ID of the DataWorks workspace. You can call the ListProjects to obtain the ID.

DataSourceType String Yes emr

The type of the data source. Only emr is supported.

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.

ClusterId String No abc

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

Response parameters

Parameter Type Example Description
RequestId String abc

The ID of the request.

DatabaseInfo Object

The information of the metadatabases.

TotalCount Long 10

The total number of the metadatabases.

DbList Array of DbList

The list of metadatabases.

Type String HIVE

The type of the metadatabase.

CreateTimeStamp Long 1388776825

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

UUID String 32342

The universally unique identifier (UUID) 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.

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

The URL of the metadatabase.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListMetaDB
&ProjectId=123
&DataSourceType=emr
&PageNum=1
&PageSize=10
&ClusterId=abc
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

{
  "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 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.
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.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. 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 instance based on the specified MaxCompute project.
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 how to use the operation, see Examples of DataWorks API operations.