File Storage vePFS
File Storage vePFS
Document
- Documentation
File Storage vePFSAPI ReferenceMount serviceDescribeMountServices - Query mount services
Copy page
Download PDFMount service
DescribeMountServices - Query mount services
Copy pageDownload PDFDescribeMountServices - Query mount services
Call the DescribeMountServices API to query mount service details.
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 request parameters listed below are unique to this API and include some common parameters. For more information, see Common parameters.
Action string required Example value: DescribeMountServices
Specify the operation to perform: DescribeMountServices.
Version string required Example: 2022-01-01
API version: 2022-01-01.
Filters object[] Optional Example: See request examples for details.
Query filter for mount services.
Key string required Example: Status
Filter instances based on specific attributes. The following parameters support filtering:
- Status: Precisely filter by mount service status. Supports multiple selections separated by commas (,).
- FileSystemId: Filter precisely by file system ID.
- MountServiceName: Filter fuzzily by mount service name; multiple selections are not supported.
- MountServiceId: Filter precisely by mount service ID.
Value string required Example value: Running
Value of the filter item.
OrderBy string Optional Example value: CreateTimeDesc
Sort order for mount target services. See the following options:
- CreateTimeDesc: Sort by service creation time in descending order.
- CreateTimeAsc: Sort by service creation time in ascending order.
- NameDesc: Sort by service name in descending order.
- NameAsc: Sort by service name in ascending order.
PageSize integer Optional Example: 10
Records per page. The value must be an integer between 1 and 100. Default is 10.
PageNumberintegerOptional Example value: 1
Page number for the mount service information list; the value cannot exceed the maximum value of the Integer data type and starts from 1.
Project string Optional Example value: default
Project name.
LanguageCodestringOptional Example value: zh
Type of display language, explained as follows:
- zh: Chinese
- en: English
Response parameters
The response parameters listed below are unique to this API. For more information, see Response structure.
TotalCount integer Example: 2
Number of mount services.
MountServices object[] Example value: Refer to the return example for details.
mount target details.
Nodes object[] Example value: Refer to the return example for details.
List of client management nodes.
NodeIdstringExample value: i-yclmdnskx838df3y****
ECS instance ID.
DefaultPassword string Example value: 948E4=9@2Jbq****
Initial login password for ECS instance.
VpcId string Example value: vpc-13fz0iip9nlds3n6nu4fi****
VPC ID.
Status string Sample value: Running
Mount service status, explained as follows:
- Creating: Creating.
- CreateError: Creation failed.
- Running: Running.
- Updating: Updating.
- UpdateError: Update failed.
- Deleting: Deleting.
- DeleteError: Deletion fails.
- Deleted: Deleted.
- Attaching: Attaching.
- AttachError: Attach failed.
- Detaching: Detaching.
- DetachError: Detach failed.
- Stopped: Stopped.
- Error: Error.
ZoneId string Example value: cn-beijing-b
Zone ID.
ProjectstringExample value: default
The project to which the mount service belongs.
RegionIdstringExample value: cn-beijing
Region information.
SubnetId string Example: subnet-13fz1bsbrsw743n6nu47c****
Subnet ID.
ZoneNamestringExample value: China (Beijing) B
Availability zone.
AccountId string Example value: 210015****
User ID.
CreateTime string Example value: 2023-07-18T17:10:03+08:00
Creation time.
VersionNumber string Example: 1.4.1
Mount service version number.
MountServiceId string Example: mount-94eb****
Mount service ID.
SecurityGroupId string Example: sg-mioirewk8zcw5smt1ba8****
Client network interface security group ID.
MountServiceName string Example: mountservice
Mount service name.
AttachFileSystems object[] Example value: See the returned example for details.
Mount instance information.
Status string Example value: Attached
Binding status. Details are as follows:
- Attaching: Binding in progress.
- AttachError: Binding failed.
- Attached: Bound.
- Detaching: Unbinding in progress.
- DetachError: Unbinding failed.
AccountIdstringExample value: 210015****
Volcano Engine account ID.
CustomerPath string Example value: /vepfs-test
User mount path.
FileSystemId string Example: vepfs-cnbjbf3c46b6****
File System ID.
FileSystemName string Example: lltest
The name of the file system.
PageSize integer Example: 10
Records per page. Enter an integer between 1 and 100. The default value is 10.
PageNumber integer Example: 1
Page number for the mount service list. The value must not exceed the maximum for the Integer data type, and the starting value is 1.
Sample request
POST /?Action=DescribeMountServices&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: 20250728T074201Z
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": "Status",
"Value": "Running"
}
],
"OrderBy": "CreateTimeDesc",
"PageSize": 10,
"PageNumber": 1,
"Project": "default",
"LanguageCode": "zh"
}
Sample response
{
"ResponseMetadata": {
"RequestId": "202507281542040481231282124B****",
"Action": "DescribeMountServices",
"Version": "2022-01-01",
"Service": "vepfs",
"Region": "cn-beijing"
},
"Result": {
"TotalCount": 2,
"MountServices": [
{
"Nodes": [
{
"NodeId": "i-yclmdnskx838df3y****",
"DefaultPassword": "948E4=9@2Jbq****"
}
],
"VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
"Status": "Running",
"ZoneId": "cn-beijing-b",
"Project": "default",
"RegionId": "cn-beijing",
"SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
"ZoneName": "China (Beijing) B",
"AccountId": "210015****",
"CreateTime": "2023-07-18T17:10:03+08:00",
"VersionNumber": "1.4.1",
"MountServiceId": "mount-94eb****",
"SecurityGroupId": "sg-mioirewk8zcw5smt1ba8****",
"MountServiceName": "mountservice",
"AttachFileSystems": [
{
"Status": "Attached",
"AccountId": "210015****",
"CustomerPath": "/vepfs-test",
"FileSystemId": "vepfs-cnbjbf3c46b6****",
"FileSystemName": "lltest"
}
]
}
],
"PageSize": 10,
"PageNumber": 1
}
}
Error codes
The following table lists error codes related to this interface and its business logic. For public error codes, refer to the Public 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:48
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
