Deletes multiple partitions in a metadata table in Data Lake Formation (DLF) at a time.

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 headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

POST /api/metastore/catalogs/databases/tables/partitions/batchdelete

Request parameters

Parameter Type Position Required Example Description
Object Body No

The HTTP request body, in the JSON format.
CatalogId String Body No 1344371

The catalog ID of the metadatabase. Default value: the user ID of your Alibaba Cloud account.

DatabaseName String Body No database_test

The name of the metadatabase.
IfExists Boolean Body No true

Specifies whether to ignore errors if the partition with the specified name has been deleted.

PartitionValueList PartitionValueList Body No

The values in the partitions to be deleted.
TableName String Body No test_table_20201225

The name of the metadata table.
RegionId String Host No cn-hangzhou

The ID of the region where DLF is activated.

Response parameters

Parameter Type Example Description
Code String OK

The description of the status code.
Message String .

The error message that is returned.
PartitionErrors Array of PartitionError

The partition errors that are returned.
RequestId String B7F4B621-E41E-4C84-B97F-42B5380A32BB

The ID of the request.
Success Boolean true

Indicates whether the call was successful.

Error codes

UnknownTable: The specified metadata table does not exist.

UnknownPartition: The specified partition does not exist.

InternalError: An internal error has occurred. Troubleshoot the error based on the error message that is returned.

Examples

Sample requests

POST /api/metastore/catalogs/databases/tables/partitions/batchdelete HTTP/1.1 
  {
        "TableName":"test_table_20201225",
        "IfExists":"true",
        "DatabaseName":"database_test",
        "CatalogId":"1344371",
        "PartitionValueList": [{"Values":["20201224","12"]}]
}

Sample success responses

JSON format 

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "",
  "RequestId": "BBAB13C6-BC97-4E8D-BB02-F0F2FD77B1B2",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.