Before You Start
Overview
Welcome to Scalable File Service API Reference. Scalable File Service (SFS) is a network-attached storage (NAS) service that provides scalable, high-performance file storage. With SFS, you can enjoy shared file access spanning multiple Elastic Cloud Servers (ECSs), Bare Metal Servers (BMSs), and containers created on Cloud Container Engine (CCE).
This document describes how to use application programming interfaces (APIs) to perform operations on SFS resources, such as creating, querying, deleting, and updating a file system. For details about all supported operations, see API Overview.
If you plan to access SFS through an API, ensure that you are familiar with SFS concepts. For details, see section "Service Overview" in the Scalable File Service User Guide.
API Calling
SFS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS requests. For details about API calling, see Calling APIs.
Endpoints
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoint of SFS, see Regions and Endpoints.
Constraints
- The numbers of file systems that you can create and their capacities are determined by your quotas. To view or increase the quotas, see section "Quotas" in the Scalable File Service User Guide.
- For more details, see the constraints described in each API.
Concepts
- Account
An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.
- User
An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).
API authentication requires information such as the account name, username, and password.
- Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions cannot. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
- AZ
An Availability Zone (AZ) comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Compute, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ, high-availability systems.
- Project
A project corresponds to a region. Default projects are defined to group and physically isolate resources (including compute, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the project. If you need more refined access control, create subprojects under a default project and add resources to subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.
Figure 1 Project isolation model
- Overview
- API Calling
- Endpoints
- Constraints
- Concepts