Updated on 2025-07-22 GMT+08:00

API Overview

These APIs allow you to use all SFS Turbo functions.

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

Lifecycle Management APIs

Table 1 Lifecycle management APIs

API

Description

Creating a File System

This API is used to create a file system.

Querying Details About a File System

This API is used to query details about an SFS Turbo file system.

Deleting a File System

This API is used to delete a file system.

Listing File Systems

This API is used to list file systems.

Expanding the Capacity of a File System

This API is used to expand the capacity of a file system.

Connection Management APIs

Table 2 Connection management APIs

API

Description

Changing the Security Group Associated with a File System

This API is used to change the security group associated with an SFS Turbo file system.

Tag Management APIs

Table 3 Tag management APIs

API

Description

Adding a Tag to a File System

This API is used to add a tag to a specified file system.

Querying Tags of a File System

This API is used to query all tags of a specified file system.

Deleting a Tag from a File System

This API is used to delete a tag from a specified file system.

Batch Adding Tags to a File System

This API is used to batch add tags to a specified file system.

Querying Tags of All File Systems of a Tenant

This API is used to query the tags of all file systems of a tenant.

Querying File Systems by Tag

This API is used to query file systems by tag.

Name Management APIs

Table 4 Name management APIs

API

Description

Changing the Name of a File System

This API is used to change the name of a file system.

File System Management APIs

Table 5 File system management APIs

API

Description

Creating an Asynchronous Task for a File System

This API is used to create an asynchronous task for a file system.

Listing Asynchronous Tasks of a File System

This API is used to list asynchronous tasks of a file system.

Obtaining Details About an Asynchronous Task of a File System

This API is used to obtain the details about an asynchronous task of a file system.

Deleting an Asynchronous Task of a File System

This API is used to cancel or delete an asynchronous task of a file system.

Obtaining IP Addresses of the Clients Who Have Mounted the File System

This API is used to obtain the IP addresses of the clients who have mounted the file system.

Storage Interworking Management APIs

Table 6 Storage interworking management APIs

API

Description

Adding a Storage Backend

This API is used to add a storage backend for an SFS Turbo file system.

Listing Storage Backends

This API is used to list storage backends.

Querying Details of a Storage Backend

This API is used to obtain details about a storage backend.

Removing a Storage Backend

This API is used to remove a storage backend.

Creating a Data Import or Export Task

This API is used to create a data import or export task.

Querying Details About a Data Import or Export Task

This API is used to query details about a data import or export task.

Listing Data Import and Export Tasks

This API is used to list data import or export tasks.

Updating a File System

This API is used to update the cold data eviction duration of a file system.

Directory Management APIs

Table 7 Directory management APIs

API

Description

Creating Quota Limits for a Directory

This API is used to configure quota limits for a directory.

Updating Quota Limits of a Directory

This API is used to update the quota limits of a directory.

Querying Quota Limits of a Directory

This API is used to query the quota limits of a directory.

Removing Quota Limits from a Directory

This API is used to remove the quota limits from a directory.

Creating a Directory

This API is used to create a directory.

Checking Whether a Directory Exists

This API is used to check whether a directory exists.

Deleting a Directory from a File System

This API is used to delete a directory from a file system.

Querying the Resource Usage of a Directory

This API is used to query the resource usage of a file system directory (including usages of subdirectories).

Permissions Management APIs

Table 8 Permissions management APIs

API

Description

Joining an AD Domain

This API is used to add a file system to an AD domain.

Querying the AD Domain Configuration

This API is used to query the AD domain configuration.

Modifying the AD Domain Configuration

This API is used to modify the AD domain configuration.

Leaving an AD Domain

This API is used to remove a file system from an AD domain.

Creating a Permission Rule

This API is used to create a permission rule.

Querying Permission Rules of a File System

This API is used to query the permission rules of a file system.

Querying a Specific Permission Rule of a File System

This API is used to query a specific permission rule of a file system.

Modifying a Permission Rule

This API is used to modify a permission rule.

Deleting a Permission Rule

This API is used to delete a permission rule.

Binding to an LDAP Server

This API is used to bind to an LDAP server.

Querying the LDAP Configuration

This API is used to query the LDAP configuration.

Modifying the LDAP Configuration

This API is used to modify the LDAP configuration.

Deleting the LDAP Configuration

This API is used to delete the LDAP configuration.

Task Management APIs

Table 9 Task management APIs

API

Description

Querying Details About a Task

This API is used to query the details about a task.