All Products
Search

This Product

    PolarDB:SetPolarFsFileQuota

    Document Center

    PolarDB:SetPolarFsFileQuota

    Last Updated:Jul 31, 2026

    Sets file quota rules for a specified directory in a Polarlakebase instance.

    Operation description

    Request description

    This operation sets file quota rules for a specific directory in a Polarlakebase instance. By configuring the FilePathQuotas parameter, you can specify the directories to which quota rules are applied and their related attributes. When you use FilePathId to specify a directory, ensure that the path is an absolute path from the root directory rather than a mount point path. You can also use the Strategy parameter to control how rules take effect on existing files. By default, rules take effect only when they are missing.

    Notes

    • The maximum length of the FilePathQuotas list is 21.

    • To apply rules to multiple levels of subdirectories 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 Polarlakebase instance ID.

    pfs-2ze0i74ka607*****
    FilePathQuotas

    array<object>

    Yes

    The details of the quota rules to apply to directories.

    object

    No

    The details of the directory to which quota rules are applied.

    FilePathId

    string

    No

    The directory path.

    /a/project
    QuotaIds

    string

    No

    The IDs of the rules to apply, separated by commas (,).

    1,2
    Strategy

    string

    No

    The mode in which rules take effect on existing files. Valid values:

    • missing: Rules take effect only when they are missing. This is the default value.

    • all: Rules take effect on all files.

    missing
    MaxDepth

    integer

    No

    The number of subdirectory levels to traverse under FilePathId. A value of 1 indicates that only the first-level subdirectories are traversed. A value of 0 indicates that all levels are traversed to the deepest level.

    1
    Capacity

    integer

    No

    The quota capacity. Unit: GB.

    100
    Inodes

    integer

    No

    The quota inodes.

    100
    DBClusterId

    string

    No

    The cluster ID.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

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

    string

    The Polarlakebase instance ID.

    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.