Docs

File Storage vePFS

Fileset

DescribeFilesets - Query fileset

Call the DescribeFilesets API to query the fileset list.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this API and some common parameters are listed below. For more information, see Common parameters.

Action string required Example value: DescribeFilesets

The operation to perform: DescribeFilesets.

Version string required Example: 2022-01-01

API version: 2022-01-01.

Filtersobject[]Optional Example: See the returned example for details.

Fileset query filters.

Key string required Example: FilesetName

Filter Filesets based on specific characteristics. Supported filter parameters include:

FilesetName: Filter by Fileset name with fuzzy matching.

FilesetId: Filter by Fileset ID with precise matching.

FilesetPath: Filter by path in the file system, using fuzzy matching.

Status: Filter by Fileset status.

Value string required Example value: filset1

Filter value.

OrderBy string optional Example value: CreateTimeDesc

Fileset sorting options are described as follows:

CreateTimeDesc: Sort by Fileset creation time in descending order. This is the default sorting method.

CreateTimeAsc: Sort by Fileset creation time in ascending order.

NameDesc: Sort by Fileset name in descending order.

NameAsc: Sort by Fileset name in ascending order.

PageSize integer optional Example: 10

Number of Fileset records displayed per page. The value must be an integer from 1 to 100. The default value is 10.

PageNumber integer optional Example: 1

The page number of the Fileset list. The value must not exceed the maximum value of the Integer data type, starting from 1.

FileSystemIdstringrequired Example: vepfs-cnbjbf3c46b6****

File System ID.

Response parameters

Only the response parameters specific to this API are listed below. For more information, see Return Structure.

TotalCount integer Example: 2

Number of filesets.

Filesets object[] Example: For details, see the return sample.

Fileset details.

Status string Example value: Running

Fileset status. The value descriptions are as follows:

Creating: Creating

CreateError: Creation failed

Running: Running

Updating: Updating

UpdateError: Update failed

Deleting: Deleting

DeleteError: Deletion fails

Deleted: Deleted

Error: Error

IOPSQos integer Example value: 0

IOPS Qos.

FileUsedlongExample: 3

Number of files used.

FileLimit long Example value: 0

Quota for the number of files or directories. Returning 0 means no quota is set for the number of files or directories.

FilesetId string Example: fset-5fa4****

Fileset ID.

CreateTime string Example value: 2023-08-17T14:49:37+08:00

Fileset creation time.

FilesetName string Example: fileset1

Fileset name.

FilesetPath string Example: /aaa

Fileset absolute path.

MaxInodeNum long Example value: 100000

Fileset inode limit.

BandwidthQosintegerExample: 0

Bandwidth Qos.

CapacityUsed integer Example value: 156

Used capacity (GiB).

FileSystemId string Example: vepfs-cnbjbf3c46b6****

File System ID.

CapacityLimit integer Example value: 500

Maximum capacity quota, measured in GiB.

PageSize integer Example value: 10

Number of records per page. Enter an integer between 1 and 100. The default value is 10.

PageNumber integer Example: 1

The page number for the fileset list. Valid values must not exceed the maximum Integer data type. The start value is 1.

Sample request

POST /?Action=DescribeFilesets&Version=2022-01-01 HTTP/1.1​
Host: https://api.volcengine.com/api-explorer/?action=DescribeMountServices&groupName=%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F&serviceCode=vepfs&version=2022-01-01​
Content-Type: application/json; charset=UTF-8​
X-Date: 20250728T081644Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250728/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "Filters": [​
    {​
      "Key": "FilesetName",​
      "Value": "filset1"​
    }​
  ],​
  "OrderBy": "CreateTimeDesc",​
  "PageSize": 10,​
  "PageNumber": 1,​
  "FileSystemId": "vepfs-cnbjbf3c46b6****"​
}​

Sample response

{​
  "ResponseMetadata": {​
    "RequestId": "202507281616471930030752429D****",​
    "Action": "DescribeFilesets",​
    "Version": "2022-01-01",​
    "Service": "vepfs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "TotalCount": 2,​
    "Filesets": [​
      {​
        "Status": "Running",​
        "IOPSQos": 0,​
        "FileUsed": 3,​
        "FileLimit": 0,​
        "FilesetId": "fset-5fa4****",​
        "CreateTime": "2023-08-17T14:49:37+08:00",​
        "FilesetName": "fileset1",​
        "FilesetPath": "/aaa",​
        "MaxInodeNum": 100000,​
        "BandwidthQos": 0,​
        "CapacityUsed": 156,​
        "FileSystemId": "vepfs-cnbjbf3c46b6****",​
        "CapacityLimit": 500​
      }​
    ],​
    "PageSize": 10,​
    "PageNumber": 1​
  }​
}​

Error Code

You can visit Public Error Codes for more information on error codes.

Last updated: 2026.03.03 10:36:48