GetFileset - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Queries the information about the created fileset.

Operation description

Only CPFS V2.2.0 and CPFS for Lingjun V2.7.0 and later support this operation. You can view the version information on the file system details page in the console.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:GetFileset	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	Response information
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
Data	object	The response parameters.
Description	string	The description of the fileset.	Description
FileSystemPath	string	The directory of the fileset in the CPFS file system.	pathtoroot/fset/
FsetId	string	The fileset ID. Note This parameter is required for CPFS file systems.	fset-03250e8fe78d****
Status	string	The fileset status. Valid values: CREATING: The fileset is being created. CREATED: The fileset has been created and is running properly. RELEASING: The fileset is being released. RELEASED: The fileset has been deleted.	CREATED
CreateTime	string	The time when the fileset was created. Return format: `yyyy-MM-dd HH:mm:ss`	2025-11-21 12:49:25
UpdateTime	string	The time when the fileset was last updated. Return format: `yyyy-MM-dd HH:mm:ss`	2025-11-22 12:49:25
DeletionProtection	boolean	Specifies whether the fileset is protected from being released through the console or the DeleteFileset operation. true: Enables release protection. The fileset cannot be released. false (default): Disables release protection. The fileset can be released. Note This parameter can protect filesets only against manual releases, but not against automatic releases.	false
FileCountUsage	long	The usage of the file quantity. Note Only CPFS for LINGJUN V2.7.0 and later support this parameter.	1024
SpaceUsage	long	The capacity usage. Unit: bytes. Note Only CPFS for Lingjun V2.7.0 and later support this parameter.	1024
Quota	object	The quota information. Note Only CPFS for Lingjun V2.7.0 and later support this parameter.
SizeLimit	long	The total quota capacity limit. 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	long	The file quantity quota. Valid values: Minimum value: 10,000. Maximum value: 10,000,000,000.	10001
FileSystemId	string	The ID of the file system. The IDs of CPFS file systems must start with `cpfs-`. Example: cpfs-125487**. The IDs of CPFS for Lingjun file systems must start with `bmcpfs-`. Example: bmcpfs-0015**.	cpfs-0244729a8ef8****

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2026-01-06	Add Operation	View Change Details