Updated on 2022-09-15 GMT+08:00

API Overview

APIs provided by SFS include SFS APIs, SFS Turbo APIs, and native OpenStack APIs.

These APIs allow you to use all SFS functions.

The call frequency limit of SFS Capacity-Oriented APIs is 400 calls/minute. If you call a large number of APIs at a time, some APIs may fail to be called. You are advised to evenly arrange API calls.

Some SFS Capacity-Oriented APIs are the same as those provided by OpenStack Manila of the Mitaka version. For details about how to use them, visit the community:


For details about whether an SFS Capacity-Oriented API supports Enterprise Project, see API Permissions.

If the description about an API in this document differs from that in the community, the description in this document is used.

SFS Capacity-Oriented APIs

Table 1 API overview

File System Type






Tag management

You can use APIs in this category to tag your shared file system, making them easier to be managed.


Native OpenStack API

API version queries

You can use APIs in this category to query the versions and details of all APIs.

File systems

You can use APIs in this category to create shared file systems and obtain detailed information about them, such as the shared paths.

File system access rules

You can use APIs in this category to add, modify, and delete file system access rules, such as configuring VPC.

Quota management

If the number of created shared file systems reaches the upper limit, you can increase quota by using APIs in this category.

Capacity expansion and reduction

If you want to change the capacity of a created shared file system, you can use APIs in this category to expand or reduce the capacity.