DescribeFilesets - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Queries the information about created filesets.

Operation description

Only Cloud Parallel File Storage (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.
In Filters, FsetIds supports exact match only. FileSystemPath and Description support fuzzy match.
Combined query is supported.

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:DescribeFilesets	list	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}`	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-099394bd928c**. The IDs of CPFS for LINGJUN file systems must start with `bmcpfs-`. Example: bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****
Filters	array<object>	No	The filter that is used to query filesets.
	object	No
Key	string	No	The filter name. Valid values: FsetIds: filters filesets by fileset ID. FileSystemPath: filters filesets based on the path of a fileset in a CPFS file system. Description: filters filesets based on the fileset description. QuotaExists: filters filesets based on whether quotas exist. Note Only CPFS for LINGJUN V2.7.0 and later support the QuotaExists parameter.	FsetIds
Value	string	No	The filter value. This parameter does not support wildcards. If Key is set to FsetIds, set Value to a fileset ID or a part of the fileset ID. You can specify a fileset ID or a group of fileset IDs. You can specify a maximum of 10 fileset IDs. Example: `fset-1902718ea0ae**` or `fset-1902718ea0ae,fset-3212718ea0ae**`. If Key is set to FileSystemPath, set Value to the path or a part of the path of a fileset in a CPFS file system. The value must be 2 to 1024 characters in length. The value must be encoded in UTF-8. If Key is set to Description, set Value to a fileset description or a part of the fileset description. If Key is set to QuotaExists, set Value to true or false. If you do not specify the parameter, all filesets are returned.	fset-1902718ea0ae**,fset-3212718ea0ae**
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	long	No	The number of results for each query. Valid values: 10 to 100. Default value: 20.	20
OrderByField	string	No	The condition by which the results are sorted. Valid values: FileCountLimit: the file quantity quota SizeLimit: the capacity quota FileCountUsage: the usage of the file quantity quota SpaceUsage: the capacity usage	FileCountLimit
SortOrder	string	No	The order in which you want to sort the results. Valid values: asc (default): ascending order desc: descending order Note This parameter takes effect only if you specify the OrderByField parameter.	asc

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
FileSystemId`deprecated`	string	The ID of the file system. The IDs of CPFS file systems must start with `cpfs-`. Example: cpfs-099394bd928c**. The IDs of CPFS for LINGJUN file systems must start with `bmcpfs-`. Example: bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****
Entries	array<object>	The fileset information.
Entrie	object	The file information.
Description	string	The fileset description.	test
FileSystemPath	string	The fileset path.	pathtoroot/fset
FsetId	string	The fileset ID.	fset-1902718ea0ae****
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. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.	2021-09-30T10:08:08Z
UpdateTime	string	The time when the fileset was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2021-09-30T10:08:08Z
DeletionProtection	boolean	Specifies whether to enable deletion protection to allow you to release the fileset by using the console or by calling the DeleteFileset operation. Valid values: true: enables release protection. false: disables release protection. Note This parameter can protect filesets only against manual releases, but not against automatic releases.	true
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 capacity quota. Unit: bytes. Minimum value: 10737418240 (10 GiB). Step size: 1073741824 (1 GiB).	10737418240
FileCountLimit	long	The file quantity quota. Valid values: Minimum value: 10000. Maximum value: 10000000000.	10000
FileSystemId	string	The ID of the file system. The IDs of CPFS file systems must start with `cpfs-`. Example: cpfs-099394bd928c**. The IDs of CPFS for LINGJUN file systems must start with `bmcpfs-`. Example: bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****

Examples

Sample success responses

JSONformat

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "FileSystemId": "bmcpfs-290w65p03ok64ya****",
  "Entries": {
    "Entrie": [
      {
        "Description": "test",
        "FileSystemPath": "pathtoroot/fset",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "CREATED",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "DeletionProtection": true,
        "FileCountUsage": 1024,
        "SpaceUsage": 1024,
        "Quota": {
          "SizeLimit": 10737418240,
          "FileCountLimit": 10000
        },
        "FileSystemId": "bmcpfs-290w65p03ok64ya****"
      }
    ]
  }
}

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.	-
400	InvalidParameter.SortOrder	Invalid sort order.	Parameter SortOrder error.
400	InvalidParameter.SortOrderField	Invalid sort order field.	Parameter SortOrderField error.
403	OperationDenied.FilesetNotSupported	The operation is not supported.	-
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	-
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	-
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.	-
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	-

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

Change history

Change time	Summary of changes	Operation
2024-10-24	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-31	The Error code has changed. The response structure of the API has changed	View Change Details