All Products
Search
Document Center

Apsara File Storage NAS:SetDirQuota

Last Updated:Mar 03, 2024

Creates a directory quota for a file system.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

1ca404****
PathstringYes

The absolute path of a directory.

/data/sub1
QuotaTypestringYes

The type of the quota.

Valid values:

  • Accounting: a statistical quota. If you set this parameter to Accounting, NAS calculates only the storage usage of the directory.
  • Enforcement: a restricted quota. If you set this parameter to Enforcement and the storage usage exceeds the quota, you can no longer create files or subdirectories for the directory, or write data to the directory.
Accounting
UserTypestringYes

The type of the user.

Valid values:

  • Uid: user ID
  • Gid: user group ID
  • AllUsers: all users
Uid
UserIdstringNo

The UID or GID of the user for whom you want to set a directory quota.

This parameter is required and valid only if the UserType parameter is set to Uid or Gid.

Examples:

  • If you want to set a directory quota for a user whose UID is 500, set the UserType parameter to Uid and set the UserId parameter to 500.
  • If you want to set a directory quota for a user group whose GID is 100, set the UserType parameter to Gid and set the UserId parameter to 100.
500
SizeLimitlongNo

The size of files that a user can create in the directory.

Unit: GiB.

If you set the QuotaType parameter to Enforcement, you must specify at least one of the SizeLimit and FileCountLimit parameters.

1024
FileCountLimitlongNo

The number of files that a user can create in the directory.

This number includes the number of files, subdirectories, and special files.

If you set the QuotaType parameter to Enforcement, you must specify at least one of the SizeLimit and FileCountLimit parameters.

10000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5BC5CB97-9F28-42FE-84A4-0CD0DF42****
Successboolean

Indicates whether the request was successful.

Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
404InvalidParameter.DirPathNotExistThe Dir Path does not exist

For a list of error codes, visit the Service error codes.