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:

https://docs.openstack.org/api-ref/shared-file-system/

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	Type	Category	Description
SFS	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.
		Limits 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.

SFS Turbo APIs

By using the SFS Turbo APIs, you can create, delete, query SFS Turbo file systems as well as expanding the capacity of an SFS Turbo file system.

**Table 2** API overview
Type	Category	Description
SFS Turbo API	Lifecycle management	You can use APIs in this category to create or delete a file system, query file system details, list file systems, and expand the capacity of a file system.
SFS Turbo API	Connection management	You can use the API in this category to change the security group of an SFS Turbo file system.
SFS Turbo API	Tag management	You can use APIs in this category to add a tag to or delete a tag from a file system, query tags of a file system, batch add tags to a file system, query tags of all file systems of a tenant, and query file systems by tag.
SFS Turbo API	Name management	You can use the API in this category to change the name of a file system.
SFS Turbo API	File system management	You can use APIs in this category to create an asynchronous task for a file system, list asynchronous tasks of a file system, obtain details about an asynchronous task of a file system, delete an asynchronous task of a file system, and obtain IP addresses of the clients who have mounted the file system.
SFS Turbo API	Storage interworking management	You can use APIs in this category to associate a directory in your SFS Turbo file system with an OBS bucket and create data import or export tasks to synchronize data.
SFS Turbo API	Directory management	You can use APIs in this category to create, update, query, or delete quota limits of a directory, create or delete a directory, check whether a directory exists, and query the resource usage of a directory.
SFS Turbo API	Permissions management	You can use APIs in this category to manage the permissions of SFS Turbo file systems.
SFS Turbo API	Task management	You can use the API in this category to query details about a task.

General Purpose File System APIs

**Table 3** API overview
Type	Category	Description
General Purpose File System API	File systems	You can use APIs in this category to create, delete, or list General Purpose File Systems.
General Purpose File System API	File system access rules	You can use APIs in this category to configure, obtain, or delete file system access rules.
General Purpose File System API	Tags	You can use APIs in this category to add, delete, or query tags in batches.