SetPolarFsFileQuota - - Alibaba Cloud Documentation Center

Operation description

This operation sets file quota rules for a specific directory in a PolarFS instance. Configure the FilePathQuotas parameter to specify the directory and its properties for the quota rule. When using FilePathId to specify a directory, ensure the path is an absolute path from the root directory, not a mount target path. You can also use the Strategy parameter to control how the rule applies to existing files. By default, the rule takes effect only if no rule already exists.

Notes

The FilePathQuotas list can contain a maximum of 21 items.
To apply the rule to multilayer subdirectories under FilePathId, set the MaxDepth parameter. To traverse to the deepest level, set this parameter 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

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	The details of the directory application rules.
	object	No	The details of the directory application.
FilePathId	string	No	The directory.	/a/project
QuotaIds	string	No	A list of rule IDs to apply, separated by commas (`,`).	1,2
Strategy	string	No	The pattern for how the rule applies to existing files. Valid values: missing: The rule takes effect only if no rule is present. This is the default value. all: The rule applies to all files.	missing
MaxDepth	integer	No	The number of directory levels to traverse under `FilePathId`. A value of 1 indicates that the first-level subdirectory is traversed. A value of 0 indicates that the traversal goes to the deepest level.	1
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.