All Products
Search
Document Center

Data Management:BatchDeleteDataLakePartitions

Last Updated:Nov 08, 2025

Deletes multiple partitions of a table in a data lakehouse at a time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:BatchDeleteDataLakePartitionsdelete
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CatalogNamestringYes

The name of the data catalog.

hive
DbNamestringYes

The database name.

default
TableNamestringYes

The table name.

table_name
PartitionValuesListarrayYes

The values in a partition key column.

arrayYes

The values in a partition key column.

stringNo

The value of the partition key column.

part_val1
IfExistsbooleanNo

Specifies whether to ignore the exception if the partition that you want to delete does not exist.

true
DataRegionstringYes

The region where the data lake resides.

cn-hangzhou
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
3****
WorkspaceIdlongNo

The workspace ID.

12****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

5B96E35F-A58E-5399-9041-09CF9A1E46EA
ErrorCodestring

The error code that is returned if the request failed.

UnknownError
ErrorMessagestring

The error message that is returned if the request failed.

UnknownError
Successstring

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
PartitionErrorsarray

The error messages.

PartitionErrorPartitionError

The error message.

Examples

Sample success responses

JSONformat

{
  "RequestId": "5B96E35F-A58E-5399-9041-09CF9A1E46EA",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "PartitionErrors": [
    {
      "ErrorDetail": "",
      "Values": [
        ""
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.