Introduction
Last updated:2026-03-24 17:01:59
Introduction
Last updated: 2026-03-24 17:01:59
Overview
Cloud File Storage (CFS) provides a scalable shared file storage service that can be used in conjunction with Tencent Cloud's CVM, container, and batch computing services. CFS supports standard NFS and CIFS/SMB file system access protocols, offering a shared data source for multiple CVM instances or other computing services. It supports elastic capacity and performance scaling, and can be mounted on existing applications without modification. As a highly available and reliable distributed file system, CFS is suitable for big data analysis, media processing, content management, and other scenarios.
-All file storage API interfaces introduced in this section comply with the latest OpenAPI 3.0 specification.
-You can call the API to perform file storage operations, such as create a file system, query file system details, and delete file system.
-For ALL supported API information of file storage, see API overview.
-When calling the following interfaces, please ensure you fully understand the CFS product, create and use, and billing mode.
Glossary
Common terminology for file storage API interface, see the table below:
| Term | Description |
|---|---|
| CFS, or Cloud File Storage, is a shared file storage service that provides access via standard network file system protocols such as NFS and CIFS. It is used to build high-performance, expandable, and reliable file sharing systems in the cloud for multiple cloud servers (CVM) or containers to simultaneously access. | |
| KiB | Kibibyte, a storage capacity unit. 1KiB = 1024Bytes. Used for precise file or storage system capacity. |
| MiB | Mebibyte, a storage capacity unit. 1MiB = 1024KiB = 1,048,576Bytes. It is used for precise capacity representation of files or storage systems. |
| GiB | Gibibyte, a storage capacity unit, 1GiB = 1024MiB = 1,073,741,824Bytes. Used for precise representation of file or storage system capacity. |
| TiB | Tebibyte, a storage capacity unit. 1TiB = 1024GiB. Used to represent large file system capacity. |
| PiB | Pebibyte, a measurement unit of data storage capacity, 1PiB = 1024TiB. It is used to represent the capacity of hyperscale file systems. |
| NFS, Network File System, is a distributed file system protocol. Through the NFS protocol, you can access files on a remote system just like accessing local files. It is the standard protocol for file sharing between Linux/Unix systems. The Universal Series file system of CFS supports service provision via the NFS protocol. | |
| CIFS, or Common Internet File System, is a public version of the SMB (Server Message Block) protocol. It is primarily used for file sharing between Windows systems over a network. The general series file system of CFS supports the CIFS/SMB protocol. | |
| TURBO | The file system protocol used by private clients in the CFS Turbo series file system. The Turbo series is designed for I/O-intensive scenarios such as AI training, high-performance computing (HPC), and media processing that require ultra-high performance, low delay, and high-throughput support. |
| SD | Standard, which stands for CFS Universal Standard File Storage. Suitable for small-scale general data storage scenarios. |
| HP | High-Performance, which is CFS general performance file storage. It is suitable for small-scale latency-sensitive core business. |
| TB | Standard Turbo, also known as CFS Turbo standard file storage. Suitable for large-scale throughput and mixed-load business. |
| TP | High-Performance Turbo, also known as CFS Turbo file storage. Suitable for large-scale small file businesses. |
| THP | High-Throughput, the CFS throughput-oriented file storage. Suitable for rendering, game battle server and non-linear edit in read-intensive scenarios. |
| VPC (Virtual Private Cloud) is a Private network, a logically isolated network space that you define on Tencent Cloud. It provides network isolation and secure access control for the CFS file system, which is typically deployed in a VPC to ensure security. | |
| CCN (Cloud Connect Network) provides intranet interconnection between VPCs on Tencent Cloud and between VPCs and IDCs. It is used to access the Turbo file system in an exclusive VPC from a user-built VPC. | |
| CidrBlock | Classless Inter-Domain Routing Block (CIDR block). It is used to assign an IP address range (for example, 10.0.0.0/24) to the CFS Turbo file system in Cloud Connect Network (CCN). It is the foundation for configuring the turbo file system network. |
| PGroup | Permission Group is a configuration collection in CFS for managing file system access permissions. It binds rules to file systems to control allowed IP addresses for accessing file systems as well as read-write or read-only permissions. |
| UID | User Identifier, the user ID. In Linux/Unix systems, it is a unique number used to identify a system user. It is used for controlling access permission to files and directories (owner) at the file system layer. |
| GID, Group Identifier, is the group ID. In Linux/Unix systems, it is a unique number used to identify user groups. It controls access permission for files and directories (group to which the executing user belongs) at the file system layer. | |
| Snapshot. A Snapshot is a replica of the file system data status at a certain point in time. It is used for data backup, disaster recovery, and version roll back. CFS provides general series snapshots and Turbo series snapshots. | |
| LifecyclePolicy is a lifecycle management policy. It is used to automatically execute data management, such as transferring infrequently accessed data from standard storage to lower cost infrequent storage based on preset rules (for example, last access time of files) to optimize storage costs. |
Usage Limits
Since technical architecture and development cycle vary, different types of file systems have different specifications and features. For details, see system limitations (https://www.tencentcloud.com/document/product/582/9135?from_cn_redirect=1). For specific parameter limits, refer to the output parameter description in each API document.
Getting Started with APIs
To use the CFS standard file system through API, you can use the API Explorer tool as follows:
- Activate CFS service: you can use the api for the query (https://cloud.tencent.com/document/api/582/38163) to activate CFS service.
- Query region availability: You can use the Query Region Availability (https://cloud.tencent.com/document/api/582/38171) API to learn about resource sale status in each availability zone as well as supported storage types, storage protocol, etc., and underwrite that the general standard type (SD) is available for sale in the region where you expect to create a file system.
- Create permission group and permission group rule: You can use the create permission and create permission group rule APIs to configure permission group for managing file system access permission.
- Create a common standard file system: You can use the create file system API to define file system detailed settings and associate the created permission group.
- Query file system: You can use the Query file system API (https://cloud.tencent.com/document/api/582/38170) to view file system status and detailed settings.
- Mount the file system on a cloud server: After the file system is created successfully, you can mount the file system on a cloud server. Refer to Using CFS file system on a Linux client for mounting methods, which include command line and console mounting.
- Unmount the file system on a cloud server: When you no longer need to use the file system, you can unmount it on the cloud server. For the uninstallation method, refer to Using CFS File System on a Linux Client, which provides multiple methods such as command line unmount and graphical interface unmount (Windows).
- Delete file system: Once you have uninstalled the file system on the cloud server, you can call the Delete File System API to delete it. After deletion, the file system will no longer incur fees.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback