DescribeFilesets API Overview - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the list of created filesets.

Operation description

Only CPFS 2.2.0 and later and CPFS for Lingjun 2.7.0 and later support filesets. You can view the version information on the file system details page in the console.
For filter keys (Filters), FsetIds requires an exact match, while FileSystemPath and Description support fuzzy match.
Combined queries are supported.

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

list

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID. CPFS: The ID must start with `cpfs-`, such as cpfs-099394bd928c**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****
Filters	array<object>	No	The filter key information for the filesets to query.
	object	No
Key	string	No	The name of the filter key. Valid values: FsetIds: filters by fileset ID. FileSystemPath: filters by the path of the fileset in the CPFS file system. Description: filters by the description of the fileset. QuotaExists: filters by whether a quota exists. Note Only CPFS for Lingjun 2.7.0 and later support filtering by the QuotaExists parameter. Valid values: FileSystemPath : 根据 Fileset 在 CPFS 文件系统中的路径筛选 Description : 根据 Fileset 的描述筛选 FsetIds : 根据 Fileset ID 筛选 QuotaExists : 根据 Quota 是否存在进行筛选	FsetIds
Value	string	No	The value of the filter key. Wildcards are not supported for this parameter. If Key is set to FsetIds, Value is set to a fileset ID. You can specify one or more fileset IDs, up to 10. Separate multiple values with commas (,). Example: `fset-1902718ea0ae**` or `fset-1902718ea0ae,fset-3212718ea0ae**`. If Key is set to FileSystemPath, Value is set to the full or partial path of the fileset in the CPFS file system. The value must be 2 to 1,024 characters in length and encoded in UTF-8. If Key is set to Description, Value is set to the full or partial description of the fileset. If Key is set to QuotaExists, Value is set to true or false. If you leave this parameter empty, all filesets are returned.	fset-1902718ea0ae****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the return results are truncated, you can use this token in the next request to retrieve the remaining results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	No	The number of results per query. Valid values: 10 to 100. Default value: 20.	20
OrderByField	string	No	The field by which to sort the results. FileCountLimit: the quota file count limit. SizeLimit: the quota capacity limit. FileCountUsage: the file count usage. SpaceUsage: the capacity usage. Valid values: SpaceUsage : capacity usage. FileCountLimit : quota file count limit. SizeLimit : quota capacity limit. FileCountUsage : file count usage.	FileCountLimit
SortOrder	string	No	The sort order. Valid values: asc (default): ascending order, which sorts results from smallest to largest. desc: descending order, which sorts results from largest to smallest. Note This parameter takes effect only when the OrderByField parameter is specified. Valid values: asc : ascending order. desc : descending order.	asc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If the return results are truncated, you can use this token in the next request to retrieve the remaining results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
FileSystemId `deprecated`	string	The file system ID. CPFS: The ID must start with `cpfs-`, such as cpfs-099394bd928c**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****
Entries	object
Entrie	array<object>	The collection of fileset information.
	array<object>	The collection of 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	integer	The usage of the file quantity. Note Only CPFS for LINGJUN V2.7.0 and later support this parameter.	1024
SpaceUsage	integer	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	integer	The capacity quota. Unit: bytes. Minimum value: 10737418240 (10 GiB). Step size: 1073741824 (1 GiB).	10737418240
FileCountLimit	integer	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.