Docs

File Storage vePFS

Category

DescribeFileSystemOverview - Query file system overview information

Call the DescribeFileSystemOverview API to query an overview of the file system.

Debugging

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

The following lists only the unique request parameters for this endpoint and some common parameters. For more information, see Common Parameters.

Action string required Example value: DescribeFileSystemOverview

The action to perform. Value: DescribeFileSystemOverview.

Version string required Example value: 2022-01-01

API version. Value: 2022-01-01.

Response parameters

The following lists only the unique response parameters for this endpoint. For more information, see Response Structure.

Overview object Example value: See the return example for details.

File system overview information.

RegionId string Example: cn-beijing

Region ID.

AccountId string Example: 210004****

Account ID.

ErrorCount integer Example value: 0

Number of instances with runtime errors.

OtherCount integer Example value: 0

Number of instances excluding those in Running and Error states.

TotalCount integer Example value: 2

Total number of instances.

RunningCount integer Example value: 2

Number of running instances.

Sample request

POST /?Action=DescribeFileSystemOverview&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: 20250728T033006Z​
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​
​
{}​

Sample response

{​
  "ResponseMetadata": {​
    "RequestId": "20250728113012196152174070C4****",​
    "Action": "DescribeFileSystemOverview",​
    "Version": "2022-01-01",​
    "Service": "vepfs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "OverView": {​
      "RegionId": "cn-beijing",​
      "AccountId": "210004****",​
      "ErrorCount": 0,​
      "OtherCount": 0,​
      "TotalCount": 2,​
      "RunningCount": 2​
    }​
  }​
}​

Error codes

The table below lists error codes related to this API and its 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:48