Queries metatables in a compute engine instance.

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 GetMetaDBTableList

The operation that you want to perform.

AppGuid String No odps.testProjectName

The ID of the project. Specify the ID in the format of odps.{projectName}. This parameter must be specified when you query metatables in a MaxCompute compute engine instance.

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.

PageNumber 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. This parameter must be specified when you query metatables in an EMR compute engine instance.

DatabaseName String No abc

The name of the metadatabase.

DataSourceType String No odps

The type of the compute engine instance. Valid values: odps and emr.

Response parameters

Parameter Type Example Description
Data Struct

The business data.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

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

TableEntityList Array of TableEntityList

The list of metatables in the compute engine instance.

DatabaseName String abc

The name of the metadatabase.

TableGuid String odps.engine_name.tname

The ID of the metatable.

TableName String tname

The name of the metatable.

TotalCount Long 20

The total number of metatables in the compute engine instance.

RequestId String 0bc1ec92159376

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaDBTableList
&AppGuid=odps.testProjectName
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0bc1ec92159376</RequestId>
<Data>
    <TotalCount>20</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TableEntityList>
        <TableName>1</TableName>
        <TableGuid>odps.engine_name.1</TableGuid>
        <DatabaseName>abc</DatabaseName>
    </TableEntityList>
</Data>

JSON format

{
    "RequestId": "0bc1ec92159376",
    "Data": {
        "TotalCount": 20,
        "PageSize": 10,
        "PageNumber": 1,
        "TableEntityList": {
            "TableName": "tname",
            "TableGuid": "odps.engine_name.tname",
            "DatabaseName": "abc"
        }
    }
}

Error codes

HTTP status code Error code Error message Description
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.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the maximum number of requests for the resource has been reached.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the maximum number of requests per day for the resource has been reached.
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.
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.
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 MaxCompute project.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The error message returned because the interface 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.
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 the value of the AppGuid parameter 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.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.

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

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