All Products
Search

This Product

    Cloud Parallel File Storage:CreateFileset

    Document Center

    Cloud Parallel File Storage:CreateFileset

    Last Updated:Oct 26, 2026

    Creates a Fileset.

    Operation description

    • CPFS usage notes.

      • Only CPFS 2.2.0 and later support creating Filesets. You can view the version information on the file system details page in the console.

      • A single CPFS file system supports a maximum of 10 Filesets.

      • The parent directory must be an existing directory.

      • The maximum supported depth for a Fileset path is 8 levels, with the root directory / being level 0. For example, if the Fileset path is /test/aaa/ccc/, the path depth is 3 levels.

      • Nested Filesets are not supported. If a parent directory is specified as a Fileset, its subdirectories cannot be specified as Filesets.

      • A Fileset supports a maximum of 1 million files. If the number of files exceeds this limit, adding new files returns a no space error message.

    • CPFS for Lingjun usage notes

      • Only CPFS for Lingjun 2.7.0 and later support creating Filesets. You can view the version information on the file system details page in the console.

      • A single CPFS file system supports a maximum of 500 Filesets.

      • The Fileset path must be a new path and cannot be an existing path. Fileset paths cannot be renamed and do not support symbolic links.

      • The maximum supported depth for a Fileset path is 8 levels, with the root directory / being level 0. For example, if the Fileset path is /test/aaa/ccc/, the path depth is 3 levels.

      • If the Fileset path is a multi-level directory, the parent directory must be an existing directory.

      • Nested Filesets are not supported. If a parent directory is specified as a Fileset, its subdirectories cannot be specified as Filesets. A Fileset path supports only one quota.

      • For the Fileset capacity quota, the minimum initial value is 10 GiB, and the expansion unit is 1 GiB.

      • A Fileset supports a maximum of 10 billion files or directories. The minimum initial value is 10,000, and the expansion unit is 1.

      • When modifying a directory quota, the configured quota capacity or number of files must be greater than the used capacity or number of files.

      • Quota statistics have a 15-minute delay. The current actual usage takes effect after 15 minutes.

    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:CreateFileset

    create

    *Fileset

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    FileSystemId

    string

    Yes

    The file system ID.

    • CPFS: Must start with cpfs-, for example, cpfs-099394bd928c****.

    • CPFS for Lingjun: Must start with bmcpfs-, for example, bmcpfs-290w65p03ok64ya****.

    bmcpfs-290w65p03ok64y*****
    FileSystemPath

    string

    Yes

    The absolute path of the Fileset to be created.

    • CPFS path limits:

      • The parent directory of the specified directory must be an existing directory in the file system.

      • The length is 2 to 1,024 characters.

      • The specified directory must start and end with a forward slash (/).

    • CPFS for Lingjun path limits:

      • The length is 2 to 1,024 characters.

      • The specified directory must start and end with a forward slash (/).

      • The Fileset path must be a new path and cannot be an existing path. Fileset paths cannot be renamed and do not support symbolic links.

      • The maximum supported depth for a Fileset path is 8 levels, with the root directory / being level 0. For example, if the Fileset path is /test/aaa/ccc/, the path depth is 3 levels.

      • If the Fileset path is a multi-level directory, the parent directory must be an existing directory.

      • Nested Filesets are not supported. If a parent directory is specified as a Fileset, its subdirectories cannot be specified as Filesets. A Fileset path supports only one quota.

      • The total length of the path is up to 990 characters.

    /test/
    DryRun

    boolean

    No

    Specifies whether to perform a dry run on the creation request.

    A dry run checks parameter validity and inventory, but does not actually create the instance or incur fees.

    Valid values:

    • true: sends a check request without creating the instance. Check items include whether required parameters are specified, request format, business limits, and NAS inventory. If the check fails, the corresponding error is returned. If the check succeeds, HTTP status code 200 is returned, but the FilesetId is empty.

    • false (default): sends a normal request and creates the instance directly after the check passes.

    false
    DeletionProtection

    boolean

    No

    The release protection property of the instance. Specifies whether the instance can be released through the console or the DeleteFileset API operation.

    • true: enables release protection for the instance.

    • false (default): disables release protection for the instance.

    Note

    This property only restricts manual release operations and does not apply to system release operations.

    false
    Description

    string

    No

    The description of the Fileset.

    • The length is 2 to 128 characters.

    • It must start with a letter or a Chinese character and cannot start with http:// or https://.

    • It can contain digits, colons (:), underscores (_), and hyphens (-).

    Internal transaction directory
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across different requests.

    The ClientToken parameter supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    Note

    If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.

    123e4567-e89b-12d3-a456-4266554*****
    Quota

    object

    No

    The quota information.

    Note

    This parameter is supported only by CPFS for Lingjun 2.7.0 and later.

    FileCountLimit

    integer

    No

    The limit on the number of files for the quota. Valid values:

    • Minimum value: 10,000.

    • Maximum value: 10,000,000,000.

    10000
    SizeLimit

    integer

    No

    The limit on the total capacity for the quota. Unit: bytes.

    Valid values:

    • Minimum value: 10,737,418,240 (10 GiB).

    • Step size: 1,073,741,824 (1 GiB).

    10737418240

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    98696EF0-1607-4E9D-B01D-F20930B6****
    FsetId

    string

    The Fileset ID.

    fset-1902718ea0ae****

    Examples

    Success response

    JSON format

    {
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "FsetId": "fset-1902718ea0ae****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalCharacters The parameter contains illegal characters. The parameter contains illegal characters.
    400 MissingFileSystemId FileSystemId is mandatory for this action. The FileSystemId parameter is not specified.
    400 MissingFileSystemPath FileSystemPath is mandatory for this action. The FileSystemPath parameter is missing.
    400 InvalidFilesystemType.NotSupport This Api does not support this fileSystem type. The current interface does not support this type of file system.
    400 InvalidFilesystemVersion.NotSupport This Api does not support this fileSystem version. This Api does not support this fileSystem version.
    400 InvalidRequest The request is invalid. Invalid request
    400 Quota.Invalid.Limit Quota limit is invalid. Invalid quota.
    400 Resource.Exceed.Limit Resource exceed limit. The number of resources exceeds the limit.
    400 Resource.Check.Fail Resource check failed. The resource check failed.
    400 Fileset.Path.Duplicate Fileset path is duplicate. Fileset path is duplicate.
    400 Fileset.Path.Nested Fileset path is nested. Fileset path is nested.
    400 Fileset.Path.NotExist Fileset.Path.Not.Exist. Fileset parent directory path does not exist.
    400 Fileset.Path.Exist Fileset already exist. Fileset path already exists.
    403 OperationDenied.AlreadyExists The operation is denied due to IdirName already exists in parent path. The directory name to be created already exists in the parent directory.
    403 OperationDenied.TooManyFilesets The operation is denied due to too many fileset in filesystem. The number of Fileset directories in the file system exceeds the threshold.
    403 OperationDenied.TooManyDepths The operation is denied due to Fileset path too deep. The Fileset directory path depth exceeds the threshold.
    403 OperationDenied.NestedDir The operation is denied due to nested directory. Failed to create the automatic update configuration because nested directories exist.
    403 OperationDenied.DependencyViolation The operation is denied due to dependancy violation. The conditions for performing this operation are not met.
    403 OperationDenied.FilesetNotSupported The operation is not supported. The file system does not support Fileset.
    404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
    404 InvalidFileSystemPath.ParentNotFound The specified parent path does not exist. The specified parent directory does not exist.
    404 InvalidFileSystemPath.NotDirectory The specified idir parent path is not directory. The specified parent directory is not a directory.
    404 InvalidFileSystemPath.InvalidCharacters The specified fileset path contains invalid characters. The specified Fileset path contains invalid characters.
    404 InvalidFilesetPath.InvalidParameter Fileset path is invalid. The specified fileset path is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.