nav-img
Advanced

API Overview

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:

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

Subtype

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.

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.

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

Subtype

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 the category to create an asynchronous task for a file system, list asynchronous tasks of a file system, obtain details about asynchronous tasks of a file system, and delete an asynchronous task of a file system.

SFS Turbo API

Storage interworking management

You can use APIs in this category to add a storage backend, list storage backends, obtain details about a storage backend, create an import or export task, query details about an import or export task, list import and export tasks, and update a file system.

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 create, query, modify, and delete permission rules of a file system and list permission rules of a file system.

SFS Turbo API

Task management

You can use the API in this category to query the execution status of an asynchronous task.