All Products
Search
Document Center

DataWorks:GetMetaDBTableList

Last Updated:Nov 21, 2024

Queries metatables in a compute engine instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

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

10
AppGuidstringYes

The GUID of the MaxCompute project. Specify the GUID in the odps.{projectName} format. You must configure this parameter only if you set the DataSourceType parameter to odps.

odps.testProjectName
ClusterIdstringNo

The E-MapReduce (EMR) cluster ID. You must configure this parameter only if you set the DataSourceType parameter to emr.

abc
DatabaseNamestringNo

The name of the metadatabase.

abc
DataSourceTypestringNo

The type of the data source. Valid values: odps and emr.

odps

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0bc1ec92159376
Dataobject

The metatable information in a compute engine instance.

PageNumberinteger

The page number.

1
PageSizeinteger

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

10
TotalCountlong

The total number of compute engine instances returned.

20
TableEntityListarray<object>

The list of metatables in the compute engine instance.

TableEntityListobject
TableNamestring

The name of the metatable.

tname
TableGuidstring

The GUID of the metatable.

odps.engine_name.tname
DatabaseNamestring

The name of the metadatabase.

abc

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Meta.AppNotExistThe MaxCompute project does not exist.The MaxCompute project does not exist.
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter is invalid.
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.The app guid parameter is invalid.
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.The parameter for paging is invalid.
400InvalidParameter.Meta.NotExistThe object does not exist.-
400InternalError.UserId.MissingAn internal system error occurred. Try again later.-
400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.Failed to connect to the interface network.
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.An unknown error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history