GetMetaDBTableList - 获取引擎实例下的表 - 大数据开发治理平台 DataWorks

该接口用于获取引擎实例中的表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大为 100 条。	10
AppGuid	string	是	项目的唯一标识，格式为`odps.{projectName}`。仅当数据类型为 odps 时，需要配置该参数。	odps.testProjectName
ClusterId	string	否	EMR 集群的 ID，仅当数据类型为 emr 时，需要配置该参数。	abc
DatabaseName	string	否	数据库的名称。	abc
DataSourceType	string	否	数据类型，目前仅支持 odps 和 emr。	odps

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0bc1ec92159376
Data	object	引擎实例下的表信息。
PageNumber	integer	请求的数据页数，用于翻页。	1
PageSize	integer	每页显示的条数，默认为 10 条，最大为 100 条。	10
TotalCount	long	计算引擎的总数。	20
TableEntityList	array<object>	引擎实例下的表列表。
TableEntityList	object	返回的表信息。
TableName	string	表的名称。	tname
TableGuid	string	表的唯一标识。	odps.engine_name.tname
DatabaseName	string	数据库的名称。	abc

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	MaxCompute项目不存在。
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	请求参数错误。
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	App参数错误。
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	分页信息错误。
400	InvalidParameter.Meta.NotExist	The object does not exist.	-
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	用户输入的 project 不正确
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	当前的用户不是任何租户的所有者。
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	没有权限，请授权
429	Throttling.Api	The request for this resource has exceeded your available limit.	对该资源的请求已超过您的可用上限。
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	对该资源的请求已超过您的每日可用上限。
429	Throttling.System	The DataWorks system is busy. Try again later.	DataWorks系统繁忙，请稍后再试。
429	Throttling.User	Your request is too frequent. Try again later.	您的请求过于频繁，请尝试放缓请求速度。
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	接口网络不通。
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	未知错误。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史

GetMetaDBTableList 接口的使用示例 Demo 请参见DataWorks OpenAPI 示例。