Create a directory quota for a file system using the SetDirQuota API - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

Only General-purpose NAS file systems support the directory quota feature.

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

nas:SetDirQuota

create

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	1ca404****
Path	string	Yes	The absolute path of the directory in the file system. Note You can set a quota only for a directory that has been created in the NAS file system. The directory path for the quota is the absolute path in the NAS file system, not the local path on a compute node (for example, an ECS instance or container). Directories whose path names contain Chinese characters are not supported.	/data/sub1
QuotaType	string	Yes	The quota type. Valid values: Accounting: statistical quota. Only tracks usage. Enforcement: restrictive quota. When usage exceeds the limit, operations such as creating files or directories and appending data fail. Valid values: Enforcement : Restrictive quota. Accounting : Statistical quota.	Accounting
UserType	string	Yes	The user type. Valid values: Uid: user ID Gid: user group ID AllUsers: all users Valid values: Uid : User ID. Gid : User group ID. AllUsers : All users.	Uid
UserId	string	No	The UID or GID to restrict. This parameter is required and valid only when UserType is set to Uid or Gid. Examples: To restrict the user whose UID is 500, set UserType to Uid and UserId to 500. To restrict the user group whose GID is 100, set UserType to Gid and UserId to 100.	500
SizeLimit	integer	No	The total capacity limit for files in the directory. Unit: GiB. When QuotaType is set to Enforcement, you must specify at least one of SizeLimit and FileCountLimit.	1024
FileCountLimit	integer	No	The maximum number of files in the directory. This includes files, directories, and special files. When QuotaType is set to Enforcement, you must specify at least one of SizeLimit and FileCountLimit.	10000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5BC5CB97-9F28-42FE-84A4-0CD0DF42****
Success	boolean	The request status. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "5BC5CB97-9F28-42FE-84A4-0CD0DF42****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidParameter.DirPathNotExist	The Dir Path does not exist	The directory path does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.