File Storage vePFS
File Storage vePFS
Document
- Documentation
File Storage vePFSAPI ReferenceFile systemDescribeFileSystems - List file systems
Copy page
Download PDFFile system
DescribeFileSystems - List file systems
Copy pageDownload PDFDescribeFileSystems - List file systems
Query the file system by calling the DescribeFileSystems API.
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.
Request parameters
The following lists only the unique request parameters and some common parameters for this API. For more information, see Common parameters.
Action string requiredExample value: DescribeFileSystems
Operation to perform: DescribeFileSystems.
Version string required Example value: 2022-01-01
API version: 2022-01-01.
PageSize integer optional Example value: 10
Records per page. Accepts integers from 1 to 100, with a default value of 10.
PageNumber integer Optional Example: 1
The page number of the instance information list. The value must not exceed the maximum value for the Integer data type. The starting value is 1.
OrderBy string Optional Example value: CreateTimeDesc
File system sorting type. The default is descending by creation time. The options are as follows:
- CreateTimeDesc: Descending by file system creation time.
- CreateTimeAsc: Sort by file system creation time in ascending order.
- CapacityDesc: Sort by total file system capacity in descending order.
- CapacityAsc: Sort by total file system capacity in ascending order.
- IdDesc: Sort by file system ID in descending order.
- IdAsc: Sort by file system ID in ascending order.
Filters object[] Optional Example: See the request example for details.
File system filter information, used to select file systems that meet the criteria.
Key string required Example: FileSystemName
Filter instances by specified features. The supported filter parameters are as follows:
- ChargeType: Filter precisely by billing type; multi-selection is not supported.
- FileSystemType: Filter precisely by file system type; multi-selection is not supported.
- StoreType: Filter precisely by storage specification; multi-selection is not supported.
- FileSystemName: Fuzzy filter by file system name; multi-selection is not supported.
- Status: Filter precisely by file system status; multi-selection is supported. Separate values with an English comma (,).
- ZoneId: Filter precisely by Availability Zone; multi-selection is not supported.
- Protocol: Filter precisely according to the file system protocol; does not support multiple selection.
- AccountId: Filter precisely according to the account ID associated with the file system; does not support multiple selection.
Value string required Example value: aaa
Filter project values.
TagFilters object[] Optional Sample value: See request example for details.
Tag information.
Key string required Example value: key
The tag key you need to filter.
Value string Optional Example value: value
Tag values to be filtered.
Values string[] Optional
tag Values.
LanguageCode string Optional Example value: zh
The values indicate the following:
- zh: Chinese
- en: English
FileSystemIds string Optional Example value: vepfs-cnbj4386bc8a****
Filter by instance ID. For multiple IDs, separate them with commas (,).
Project string Optional Example value: default
Filter by project name.
Response parameters
The following lists only the unique response parameters for this API. For more information, see Response structure.
TotalCount integer Example value: 1
The number of file systems.
PageSize integer Example: 10
Number of records per page The value must be an integer between 1 and 100. The default value is 10.
PageNumber integer Example value: 1
The page number for the instance information list. The value must not exceed the maximum value of the Integer type and starts from 1.
FileSystems object[] Sample value: See return example for details.
File system details.
Tags object[] Example value: see returned sample for details.
Tag information for the file system, returned when adding tags while creating the file system.
Key string Example value: tag_00
Tag key.
Type string Example: Custom
Tag types include the following:
- Custom: User-defined tag.
- System: System tag.
Value string Example value: tag_value00
Tag value.
Status string Example value: Running
The status of the file system. The options are as follows:
- Running: The instance is running.
- Creating: The instance is being created.
- CreateError: Failed to create the instance.
- Updating: The instance is being updated.
- UpdateError: Failed to update the instance.
- Expanding: The instance is being expanded.
- ExpandError: Failed to expand the instance.
- Deleting: The instance is being deleted.
- DeleteError: Failed to delete the instance.
- Stopped: The instance has been stopped.
- Error: The instance is in an error state.
ZoneId string Example value: cn-beijing-a
Zone ID.
Project string Example value: vepfs-test
The project to which the file system belongs.
FreeTime string Example value: 2022-12-22T00:00:00+08:00
The release time of the file system.
RegionId string Example value: cn-beijing
Region ID.
ZoneName string Example: North China 2 (Beijing) - Availability Zone A
Availability Zone name.
AccountId string Example value: 210004****
Account ID.
Bandwidth integer Example: 600
vePFS file system throughput limit.
StoreType string Example value: Advance_100
The file system specifications are as follows:
- Advance_100：100MB/s/TiB.
- Performance: Performance_Edition.
- Intelligent_Computing: Intelligent_Computing_Edition.
ChargeType string Example value: PayAsYouGo
Billing type. The options are as follows:
PayAsYouGo: pay-as-you-go.
CreateTime string Example: 2022-09-15T18:17:09+08:00
The time when the file system is created.
ExpireTime string Example: 2022-12-15T23:59:59+08:00
File system expiration time.
Description string Example value: test
The description of the file system.
VpcId string
Private network ID.
SubnetId string
Subnet ID.
StoreTypeEN string
Storage type English name.
CapacityInfo object Example value: { "TotalTiB": 6, "UsedGiB": 20 }
Capacity information.
UsedGiB integer Example value: 117
File system usage capacity, measured in GiB.
TotalTiB integer Example value: 28
Total capacity of the file system, measured in TiB.
ChargeStatus string Example: Normal
Billing status. The default value is Normal, which indicates normal billing.
FileSystemId string Example value: vepfs-sw07b082188a****
File System ID.
ProtocolType string Example: VePFS
File system protocol type.
FileSystemName string Example value: test
The name of the file system.
FileSystemType string Example value: VePFS
File system type. Default: VePFS.
LastModifyTime string Example: 2022-09-15T18:25:22+08:00
File system update time.
StopServiceTime string Example value: 2022-12-16T12:00:00+08:00
File system shutdown time.
StoreTypeCN string Sample value: 100MB/s/TiB
Chinese names for file system specifications. Supported values are:
- 100MB/s/TiB.
- Performance_Edition.
- Intelligent_Computing_Edition.
ReadBandwidth integer
Read bandwidth value, measured in MB/s.
WriteBandwidth integer
Write bandwidth value, in MB/s.
SecurityGroupId string
ID of the security group where the generated secondary network card is located.
ProjectName string
Associated project. Please confirm with Shuangyu whether the document is disclosed. This field matches the Project field value. (Cloud monitoring requires that the field name be Project and cannot be changed.).
VersionNumber string Example value: 1.4.0
File system version number.
Sample request
POST /?Action=DescribeFileSystems&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: 20250728T061015Z
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
{
"PageSize": 10,
"PageNumber": 1,
"OrderBy": "CreateTimeDesc",
"Filters": [
{
"Key": "FileSystemName",
"Value": "aaa"
}
],
"TagFilters": [
{
"Key": "key",
"Value": "value",
"Values": [
"OgTv8D"
]
}
],
"LanguageCode": "zh",
"FileSystemIds": "vepfs-cnbj4386bc8a****",
"Project": "default"
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20250728141019089170209014F0****",
"Action": "DescribeFileSystems",
"Version": "2022-01-01",
"Service": "vepfs",
"Region": "cn-beijing"
},
"Result": {
"TotalCount": 1,
"PageSize": 10,
"PageNumber": 1,
"FileSystems": [
{
"Tags": [
{
"Key": "tag_00",
"Type": "Custom",
"Value": "tag_value00"
}
],
"Status": "Running",
"ZoneId": "cn-beijing-a",
"Project": "vepfs-test",
"FreeTime": "2022-12-22T00:00:00+08:00",
"RegionId": "cn-beijing",
"ZoneName": "China (Beijing)",
"AccountId": "210004****",
"Bandwidth": 600,
"StoreType": "Advance_100",
"ChargeType": "PayAsYouGo",
"CreateTime": "2022-09-15T18:17:09+08:00",
"ExpireTime": "2022-12-15T23:59:59+08:00",
"Description": "test",
"VpcId": "2tHybjPKWY",
"SubnetId": "OIi2",
"StoreTypeEN": "79IdMeu0",
"CapacityInfo": {
"UsedGiB": 117,
"TotalTiB": 28
},
"ChargeStatus": "Normal",
"FileSystemId": "vepfs-sw07b082188a****",
"ProtocolType": "VePFS",
"FileSystemName": "test",
"FileSystemType": "VePFS",
"LastModifyTime": "2022-09-15T18:25:22+08:00",
"StopServiceTime": "2022-12-16T12:00:00+08:00",
"StoreTypeCN": "100MB/s/TiB",
"ReadBandwidth": 394,
"WriteBandwidth": 368,
"SecurityGroupId": "9rcoUqJOlxd",
"ProjectName": "yTmuP",
"VersionNumber": "1.4.0"
}
]
}
}
Error codes
The following table lists error codes related to the interface and business logic For common error codes, see the Common Error Codes documentation
Status Code | Error codes | Error message | Note |
500 | InternalError | Service has some internal Error. Pls Contact With Admin. | Internal error. |
Last updated: 2026.03.03 10:36:49
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
