GetFileset API Reference - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the details of a created Fileset.

Operation description

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

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

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. CPFS: The ID must start with `cpfs-`. Example: cpfs-125487**. CPFS for Lingjun: The ID must start with `bmcpfs-`. Example: bmcpfs-0015**.	cpfs-099394bd928c****
FsetId	string	Yes	The ID of the Fileset. Note This parameter is required when the file system type is CPFS.	fset-1902718ea0ae****

Response elements

Element	Type	Description	Example
	object	The response information.
RequestId	string	The ID of the request.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
Data	object	The data details.
Description	string	The description of the Fileset.	Description
FileSystemPath	string	The path of the Fileset in the CPFS file system.	pathtoroot/fset/
FsetId	string	The ID of the Fileset. Note This parameter is required when the file system type is CPFS.	fset-03250e8fe78d****
Status	string	The status of the Fileset. Valid values: CREATING: The Fileset is being created. CREATED: The Fileset is created and running normally. RELEASING: The Fileset is being released. RELEASED: The Fileset is deleted.	CREATED
CreateTime	string	The time when the Fileset was created. Format: `yyyy-MM-dd HH:mm:ss`	2025-11-21 12:49:25
UpdateTime	string	The time when the Fileset was last updated. Format: `yyyy-MM-dd HH:mm:ss`	2025-11-22 12:49:25
DeletionProtection	boolean	The release protection property of the instance. Specifies whether the instance can be released by using the console or by calling the DeleteFileset API operation. true: Release protection is enabled. false (default): Release protection is disabled. Note This property applies only to manual release operations and does not take effect on system release operations.	false
FileCountUsage	integer	The number of used files. Note This parameter is supported only by CPFS for Lingjun 2.7.0 and later versions.	1024
SpaceUsage	integer	The used storage capacity. Unit: bytes. Note This parameter is supported only by CPFS for Lingjun 2.7.0 and later versions.	1024
Quota	object	The quota information. Note This parameter is supported only by CPFS for Lingjun 2.7.0 and later versions.
SizeLimit	integer	The total capacity limit of the quota. Unit: bytes. Valid values: Minimum value: 10,737,418,240 (10 GiB). Step size: 1,073,741,824 (1 GiB).	10,737,418,240
FileCountLimit	integer	The file count limit of the quota. Valid values: Minimum value: 10,000. Maximum value: 10,000,000,000.	10001
FileSystemId	string	The ID of the file system. CPFS: The ID must start with `cpfs-`. Example: cpfs-125487**. CPFS for Lingjun: The ID must start with `bmcpfs-`. Example: bmcpfs-0015**.	cpfs-0244729a8ef8****

Examples

Success response

JSON format

{
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "Data": {
    "Description": "Description",
    "FileSystemPath": "pathtoroot/fset/",
    "FsetId": "fset-03250e8fe78d****",
    "Status": "CREATED",
    "CreateTime": "2025-11-21 12:49:25",
    "UpdateTime": "2025-11-22 12:49:25",
    "DeletionProtection": false,
    "FileCountUsage": 1024,
    "SpaceUsage": 1024,
    "Quota": {
      "SizeLimit": 0,
      "FileCountLimit": 10001
    },
    "FileSystemId": "cpfs-0244729a8ef8****"
  }
}

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.
403	OperationDenied.FilesetNotSupported	The operation is not supported.	The file system does not support Fileset.
404	InvalidFileSystem.NotFound	The specified filesystem does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.