Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Scalable File Service/ API Reference/ Getting Started (SFS Capacity-Oriented)

Getting Started (SFS Capacity-Oriented)

Updated on 2023-06-16 GMT+08:00

Scenarios

SFS provides high-performance network-attached storage (NAS) that is scalable on demand. A shared file system can be shared with multiple Elastic Cloud Servers (ECSs) and Bare Metal Servers (BMSs). If you need a fully hosted shared file storage and want to access a file system on multiple ECSs, SFS is perfect for you.

The following describes how to call the API for Creating a Shared File System. For details, see Making an API Request.

Prerequisites

You need to plan the region where a file system resides and determine the endpoint for calling an API based on the region. It can be obtained from Regions and Endpoints.

Creating a Shared File System

The following is the sample code about how to create a shared file system with the simplest configurations:
{
   "share": {
       "description": "test description",
       "share_type": "default",
       "name": "share_London",
       "metadata": {
           "key1": "value1",
           "key2": "value2"
       },
       "share_proto": "NFS",
       "size": 10,
       "is_public": false
   }
}
  • description: Specifies the description of the shared file system, which adds remarks to the shared file system.
  • share_type: Specifies the name of a share type. A share type is used to specify the type of the storage service to be allocated.
  • share_proto: Specifies the protocol types of the shared file system.
  • name: Specifies the custom name of the shared file system. For example, share_London.
  • size: Specifies the size (in GB) of the shared file system.
  • is_public: Specifies the visibility level of the shared file system. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
  • metadata: Specifies the metadata information of the shared file system. The value consists of one or more key and value pairs organized as a dictionary of strings.

Creating an Encrypted Shared File System

You can also encrypt a shared file system. You only need to add parameters related to encryption of a shared file system to the metadata of the request body. The following is an example:

{
   "share": {
       "share_type": null,
       "name": "test",
       "snapshot_id": null,
       "description": "test description",
       "metadata": {
           "#sfs_crypt_key_id": "9130c90d-73b8-4203-b790-d49f98d503df",
           "#sfs_crypt_domain_id": "3b2d9670690444c582942801ed7d457b",
           "#sfs_crypt_alias": "sfs/default"
       },
       "share_proto": "NFS",
       "share_network_id": null,
       "size": 1,
       "is_public": false
   }
}
  • #sfs_crypt_key_id: Specifies the encryption key ID. If #sfs_crypt_key_id, #sfs_crypt_domain_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
  • #sfs_crypt_domain_id: Specifies the tenant domain ID. If #sfs_crypt_domain_id, #sfs_crypt_key_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
  • #sfs_crypt_alias: Specifies the encryption key alias. If #sfs_crypt_alias, #sfs_crypt_key_id, and #sfs_crypt_domain_id exist at the same time, the data encryption function is enabled.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback