Retrieve Engine Tables via GetMetaDBTableList - DataWorks - Alibaba Cloud -

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. Set the value to GetMetaDBTableList.
PageNumber	Integer	No	1	The page number.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
AppGuid	String	Yes	odps.testProjectName	The GUID of the MaxCompute project. Specify the GUID in the `odps.{projectName}` format. This parameter must be configured if you set the DataSourceType parameter to odps.
ClusterId	String	No	abc	The E-MapReduce (EMR) cluster ID. This parameter is required only if you set the DataSourceType parameter to emr.
DatabaseName	String	No	abc	The name of the metadatabase.
DataSourceType	String	No	odps	The type of the data source. Valid values: odps and emr.

Response parameters

Parameter	Type	Example	Description
RequestId	String	0bc1ec92159376	The request ID.
Data	Object		The business data.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
TotalCount	Long	20	The total number of compute engine instances returned.
TableEntityList	Array of TableEntityList		The list of metatables in the compute engine instance.
TableName	String	tname	The name of the metatable.
TableGuid	String	odps.engine_name.tname	The GUID of the metatable.
DatabaseName	String	abc	The name of the metadatabase.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaDBTableList
&PageNumber=1
&PageSize=10
&AppGuid=odps.testProjectName
&ClusterId=abc
&DatabaseName=abc
&DataSourceType=odps
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	The MaxCompute project is not found.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The values specified for one or more request parameters are invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The values specified for one or more parameters of the application are invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	The value of the parameter for paging is invalid.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	The project specified by the user is invalid.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The current user is not a tenant owner.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permissions.
429	Throttling.Api	The request for this resource has exceeded your available limit.	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 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 DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	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.	An internal error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	The network cannot be connected.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred.

For a list of error codes, see Service error codes.

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