GetMetaTablePartition - DataWorks - Alibaba Cloud Documentation Center

You can call this operation to query only the partitions of a metatable in a MaxCompute or E-MapReduce (EMR) compute engine instance.

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	GetMetaTablePartition	The operation that you want to perform. Set the value to GetMetaTablePartition.
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.
TableGuid	String	Yes	odps.engine_name.table_name	The GUID of the metatable.
ClusterId	String	No	abc	The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr. You can log on to the EMR console to obtain the ID of the EMR cluster.
DatabaseName	String	No	abc	The name of the metadatabase. This parameter is required only if you set the DataSourceType parameter to emr. You can call the ListMetaDB operation to query the name of the metadatabase.
TableName	String	No	abc	The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr. You can call the GetMetaDBTableList operation to query the name of the metatable.
DataSourceType	String	No	emr	The type of the data source. Valid values: odps and emr.
SortCriterion	Object	No		The logic for sorting partitions in the metatable.
SortField	String	No	name	The field that is used to sort partitions in the metatable. Valid values: name and modify_time. By default, partitions in the metatable are sorted based on their creation time.
Order	String	No	desc	The order in which partitions in the metatable are sorted. Valid values: asc and desc. Default value: desc.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code returned.
ErrorMessage	String	The connection does not exist.	The error message returned.
RequestId	String	0bc1ec92159376	The ID of the request.
Success	Boolean	true	Indicates whether the request was successful.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	The error code returned.
Data	Object		The business data returned.
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	100	The total number of partitions.
DataEntityList	Array of DataEntityList		The list of partitions.
PartitionPath	String	abc	The path of the partition.
DataSize	Long	19	The size of the partition. Unit: bytes.
PartitionName	String	pt=20170614	The name of the partition.
Comment	String	Comment	The comment.
ModifiedTime	Long	1590032868000	The time when the partition was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
CreateTime	Long	1590032868000	The time when the partition was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
RecordCount	Long	233	The number of entries in the partition.
PartitionType	String	abc	The type of the partition.
PartitionGuid	String	odps.engine_name.table_name.pt=20170614	The GUID of the partition.
PartitionLocation	String	abc	The location of the Hive partition.
TableGuid	String	odps.engine_name.table_name	The GUID of the metatable.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaTablePartition
&PageNumber=1
&PageSize=10
&TableGuid=odps.engine_name.table_name
&ClusterId=abc
&DatabaseName=abc
&TableName=abc
&DataSourceType=emr
&SortCriterion={"SortField":"name","Order":"desc"}
&<Common request parameters>

Sample success responses

XML format

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

<GetMetaTablePartitionResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0bc1ec92159376</RequestId>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <DataEntityList>
            <PartitionPath>abc</PartitionPath>
            <DataSize>19</DataSize>
            <PartitionName>pt=20170614</PartitionName>
            <Comment>Comment</Comment>
            <ModifiedTime>1590032868000</ModifiedTime>
            <CreateTime>1590032868000</CreateTime>
            <RecordCount>233</RecordCount>
            <PartitionType>abc</PartitionType>
            <PartitionGuid>odps.engine_name.table_name.pt=20170614</PartitionGuid>
            <PartitionLocation>abc</PartitionLocation>
            <TableGuid>odps.engine_name.table_name</TableGuid>
        </DataEntityList>
    </Data>
</GetMetaTablePartitionResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0bc1ec92159376",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "DataEntityList" : {
      "PartitionPath" : "abc",
      "DataSize" : 19,
      "PartitionName" : "pt=20170614",
      "Comment" : "Comment",
      "ModifiedTime" : 1590032868000,
      "CreateTime" : 1590032868000,
      "RecordCount" : 233,
      "PartitionType" : "abc",
      "PartitionGuid" : "odps.engine_name.table_name.pt=20170614",
      "PartitionLocation" : "abc",
      "TableGuid" : "odps.engine_name.table_name"
    }
  }
}

Error codes


HTTP status code	Error code	Error message	Description
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.IllegalDate	The date format is invalid.	The error message returned because the date format is 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.
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.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.
500	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.
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 GetMetaTablePartition operation, see Examples of DataWorks API operations.