All Products
Search

This Product

    PolarDB:SetPolarFsFileQuota

    Document Center

    PolarDB:SetPolarFsFileQuota

    Last Updated:May 14, 2026

    Sets file quota rules for specific directories in a PolarFS instance.

    Operation description

    Request

    This operation sets file quota rules for specific directories in a PolarFS instance. Use the FilePathQuotas parameter to define the target directories and their properties. The path for FilePathId must be an absolute path from the root directory, not from a mount target. The Strategy parameter controls how the rule applies to existing files. By default, the operation applies a rule only if one does not already exist.

    Notes

    • The FilePathQuotas list can contain up to 21 items.

    • To apply the rule to subdirectories at multiple levels under FilePathId, set the MaxDepth parameter. To traverse to the deepest level, set this value to 0.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:SetPolarFsFileQuota

    none

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PolarFsInstanceId

    string

    Yes

    The ID of the PolarFS instance.

    pfs-2ze0i74ka607*****
    FilePathQuotas

    array<object>

    Yes

    An array of objects defining the file quota rules for specific directories.

    object

    No

    FilePathId

    string

    No

    The absolute path of the directory.

    /a/project
    QuotaIds

    string

    No

    A list of file quota rule IDs, separated by a comma (,).

    1,2
    Strategy

    string

    No

    Specifies how to apply the rule to existing files. Valid values:

    • missing: Applies the rule only if one does not already exist. (Default)

    • all: Applies the rule to all files.

    missing
    MaxDepth

    integer

    No

    The maximum depth of subdirectories to traverse under the path specified by FilePathId. A value of 1 traverses only the first level of subdirectories. A value of 0 traverses to the deepest level.

    1
    Capacity

    integer

    No

    The capacity quota in GB.

    100
    Inodes

    integer

    No

    The inode quota.

    100
    DBClusterId

    string

    No

    The cluster ID.

    pc-**************

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    925B84D9-CA72-432C-95CF-738C22******
    PolarFsInstanceId

    string

    The ID of the PolarFS instance.

    pfs-2ze0i74ka607*****

    Examples

    Success response

    JSON format

    {
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "PolarFsInstanceId": "pfs-2ze0i74ka607*****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.