File Storage vePFS
File Storage vePFS
Document
- Documentation
File Storage vePFSAPI ReferenceData FlowDescribeDataFlowBandwidth - Query data flow bandwidth
Copy page
Download PDFData Flow
DescribeDataFlowBandwidth - Query data flow bandwidth
Copy pageDownload PDFDescribeDataFlowBandwidth - Query data flow bandwidth
Call the DescribeDataFlowBandwidth API to query data flow bandwidth information.
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 section lists only unique request parameters and some common parameters for this endpoint. For more information, see Common Parameters.
Action string required Example value: DescribeDataFlowBandwidth
The action to be performed. Value: DescribeDataFlowBandwidth.
Version string required Example: 2022-01-01
The API version; value: 2022-01-01.
FileSystemId string required Example value: vepfs-cnbj4c83fc4a9****
File System ID.
PageSize integer Optional Example: 10
Records per page. Acceptable values are integers between 1 and 100. The default value is 10.
PageNumber integer optional Example: 1
The page number in the list, with values up to the maximum for the Integer data type; starts at 1.
Response parameters
The following section lists only unique response parameters for this endpoint. For more information, see Response Structure.
FileSystemId string Example: vepfs-cnbj4c83fc4a9****
File System ID.
Bandwidth integer Example: 500
Transfer bandwidth for data flow, measured in MB/s.
BandwidthPerNode integer Example value: 500
Bandwidth increment, measured in MB/s.
BandwidthMin integer Example value: 0
The minimum configurable bandwidth in MB/s. The default is 0.
BandwidthMax integer Example value: 20000
The maximum configurable bandwidth in MB/s.
Status string Example value: Running
Cluster status for data flow. Details are as follows:
- Running: running.
- None: not configured.
- Configuring: configuring.
CreateTime string Example value: 2025-05-21T20:00:23+08:00
Data flow creation time.
UpdateTime string Example value: 2025-05-21T20:11:20+08:00
Data flow modification time.
Sample request
POST /?Action=DescribeDataFlowBandwidth&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: 20250729T024627Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250729/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"FileSystemId": "vepfs-cnbj4c83fc4a9****",
"PageSize": 10,
"PageNumber": 1
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20250729104631056108063106E9****",
"Action": "DescribeDataFlowBandwidth",
"Version": "2022-01-01",
"Service": "vepfs",
"Region": "cn-beijing"
},
"Result": {
"FileSystemId": "vepfs-cnbj4c83fc4a9****",
"Bandwidth": 500,
"BandwidthPerNode": 500,
"BandwidthMin": 0,
"BandwidthMax": 20000,
"Status": "Running",
"CreateTime": "2025-05-21T20:00:23+08:00",
"UpdateTime": "2025-05-21T20:11:20+08:00"
}
}
Error codes
The following table lists the error codes related to this interface and business logic. For common error codes, see the Common Error Codes documentation.
Status Code | Error Code | 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
