GetMetaDBTableList - DataWorks

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetMetaDBTableList	要执行的操作。
AppGuid	String	是	odps.testProjectName	项目的唯一标识，格式为`odps.{projectName}`。仅当数据类型为odps时，需要配置该参数。
RegionId	String	是	cn-shanghai	地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
PageNumber	Integer	否	1	请求的数据页数，用于翻页。
PageSize	Integer	否	10	每页显示的条数，默认为10条，最大为100条。
ClusterId	String	否	abc	EMR集群的ID，仅当数据类型为emr时，需要配置该参数。
DatabaseName	String	否	abc	数据库的名称。
DataSourceType	String	否	odps	数据类型，目前仅支持odps和emr。

返回数据


名称	类型	示例值	描述
Data	Struct		业务数据。
PageNumber	Integer	1	请求的数据页数，用于翻页。
PageSize	Integer	10	每页显示的条数，默认为10条，最大为100条。
TableEntityList	Array of TableEntityList		实例数据列表。
DatabaseName	String	abc	数据库的名称。
TableGuid	String	odps.engine_name.tname	表的唯一标识。
TableName	String	tname	表的名称。
TotalCount	Long	20	计算引擎的总数。
RequestId	String	0bc1ec92159376	请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetMetaDBTableList
&AppGuid=odps.testProjectName
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<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格式

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

错误码


HttpCode	错误码	错误信息	描述
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
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.	您的请求过于频繁，请尝试放缓请求速度。
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	当前的用户不是任何租户的所有者。
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	根据ODPS项目{0}获取计算引擎失败。
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	接口网络不通。
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	未知错误。
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.	数据不存在。
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	您被限制访问，请开通DataWorks企业版或旗舰版。

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

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