Queries metatables in a compute engine instance.
Debugging
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 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. |
AppGuid | String | Yes | odps.testProjectName |
The globally unique identifier (GUID) of the MaxCompute project. Specify the GUID
in the |
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. |
ClusterId | String | No | abc |
The ID of the E-MapReduce (EMR) cluster. This parameter must be configured 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 ID of the request. |
Data | Object |
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. |
TotalCount | Long | 20 |
The total number of compute engine instances. |
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 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.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. |
400 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | The error message returned because an internal error has occurred. Try again later. |
400 | 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. |
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.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 the example on how to use the GetMetaDBTableList operation, see Examples of DataWorks API operations.