All Products
Search

This Product

    :DeletePolarFsObjects

    Document Center

    :DeletePolarFsObjects

    Last Updated:Mar 24, 2026

    Deletes one or more objects from a PolarFS instance.

    Operation description

    Description

    • The PolarFsInstanceId parameter is required and specifies the target PolarFS instance.

    • The DBClusterId parameter is optional. It associates the operation with a specific PolarDB cluster.

    • The ObjectsToDelete parameter is a required array of strings specifying the paths of the objects to delete.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST / HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PolarFsInstanceId

    string

    Yes

    The ID of the PolarFS instance.

    pfs-2ze0i7*****
    DBClusterId

    string

    No

    The ID of the cluster.

    pc-***
    ObjectsToDelete

    array

    Yes

    The paths of the objects to delete.

    string

    No

    The path of an object to delete.

    test001/

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned for the request.

    RequestId

    string

    The ID of the request.

    C890995A-CF06-4F4D-8DB8-DD26C2******
    PolarFsInstanceId

    string

    The ID of the PolarFS instance.

    pfs-2ze0i7*****

    Examples

    Success response

    JSON format

    {
  "RequestId": "C890995A-CF06-4F4D-8DB8-DD26C2******",
  "PolarFsInstanceId": "pfs-2ze0i7*****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.