All Products
Search

This Product

    File Storage NAS:SetDirQuota

    Document Center

    File Storage NAS:SetDirQuota

    Last Updated:Nov 07, 2024

    Creates a directory quota for a file system.

    Operation description

    Only General-purpose File Storage NAS (NAS) file systems support the directory quota feature.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    nas:SetDirQuotacreate
    • FileSystem
      acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the file system.

    		1ca404****
    PathstringYes

    The absolute path of the directory in the file system.

    Note
  • You can set quotas only for the directories that have been created in a NAS file system. The path of the directory that you specify for a quota is the absolute path of the directory in the NAS file system, but not the local path of the compute node, such as an Elastic Compute Service (ECS) instance or a container.
  • Directories whose names contain Chinese characters are not supported.
    •
    		/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.

    Change history

    Change timeSummary of changesOperation
    2024-09-05API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details