Retrieves the partition list of a MaxCompute or EMR table.
Operation description
Only MaxCompute and EMR tables are supported. For EMR, supported cluster types are new data lake clusters managed by Data Lake Formation (DLF), and Hadoop clusters earlier than V3.41.0 or V5.7.0.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dataworks:* |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
Entries per page. Default: 10. Maximum: 100. |
10 |
| TableGuid |
string |
No |
Unique identifier of the table. |
odps.engine_name.table_name |
| ClusterId |
string |
No |
EMR cluster ID. Required only if DataSourceType is EMR. Obtain the cluster ID from the EMR console. |
abc |
| DatabaseName |
string |
No |
Database name. Required only if DataSourceType is EMR. You can query database names by calling ListMetaDB. |
abc |
| TableName |
string |
No |
EMR table name. Required only if DataSourceType is EMR. You can query table names by calling GetMetaDBTableList. |
abc |
| DataSourceType |
string |
No |
Data source type. Valid values: ODPS and EMR. |
emr |
| SortCriterion |
object |
No |
Partition sorting criteria. |
|
| SortField |
string |
No |
Sort field. Valid values: name and modify_time. Default: partition creation time. |
name |
| Order |
string |
No |
Sort order. Valid values: asc and desc. Default: desc. |
desc |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| ErrorMessage |
string |
The error message. |
The connection does not exist. |
| RequestId |
string |
The request ID. |
0bc1ec92159376 |
| Success |
boolean |
Whether the request succeeded. |
true |
| ErrorCode |
string |
The error code. |
Invalid.Tenant.ConnectionNotExists |
| Data |
object |
Business data. |
|
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
Entries per page. Default: 10. Maximum: 100. |
10 |
| TotalCount |
integer |
Total number of partitions. |
100 |
| DataEntityList |
array<object> |
Partition list. |
|
|
object |
Partition entity. |
||
| PartitionPath |
string |
Partition directory path. |
abc |
| DataSize |
integer |
Partition size, in bytes. |
19 |
| PartitionName |
string |
The name of the partition. |
pt=20170614 |
| Comment |
string |
The remarks. |
Comment |
| ModifiedTime |
integer |
Last modified time, in milliseconds. |
1590032868000 |
| CreateTime |
integer |
Creation time, in milliseconds. |
1590032868000 |
| RecordCount |
integer |
Number of records in the partition. |
233 |
| PartitionType |
string |
The type of the partition. |
abc |
| PartitionGuid |
string |
The unique identifier of the partition. |
odps.engine_name.table_name.pt=20170614 |
| PartitionLocation |
string |
Hive partition storage location. |
abc |
| TableGuid |
string |
The unique identifier of the table. |
odps.engine_name.table_name |
Examples
Success response
JSON format
{
"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 request parameter is invalid. |
| 400 | InvalidParameter.Meta.Illegal | The app guid parameter is invalid. | The app guid parameter is invalid. |
| 400 | InvalidParameter.Meta.IllegalDate | The date format is invalid. | The date format is invalid. |
| 400 | InvalidParameter.Meta.IllegalPageError | The parameter for paging is invalid. | The parameter for paging is invalid. |
| 400 | InvalidParameter.Meta.NotExist | The object does not exist. | |
| 400 | InternalError.Meta.NoCalcEngine | An error occurred while retrieving the compute engine based on the MaxCompute project. | Incorrect project entered by user |
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 500 | InternalError.Meta.TenantTimeOut | Failed to connect to the interface network. | Failed to connect to the interface network. |
| 500 | InternalError.Meta.Unknown | An unknown error occurred while processing your request. | An unknown error occurred while processing your request. |
| 403 | Forbidden.Meta.NoTenant | The user is not the owner of any tenants. | The user is not the owner of any tenants. |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 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. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.