All Products
Search
Document Center

Cloud Storage Gateway:Manage file gateways

Last Updated:Apr 17, 2026

Create, delete, and rename file gateways in the Cloud Storage Gateway (CSG) console.

Prerequisites

  • An Alibaba Cloud account is created and real-name verification for the account is complete. For more information, see Create an Alibaba Cloud account.

    Note

    We recommend creating a RAM user and logging on to the CSG console as the RAM user for routine operations.

  • CSG is activated. If CSG is not activated, follow the on-screen instructions in the CSG console to activate it.

  • A virtual private cloud (VPC) is available in the region where you want to create the file gateway. For more information, see VPCs and vSwitches.

  • An ECS instance is created in the VPC where you want to deploy the file gateway.

    Note

    If your on-premises host is connected to the VPC over an Express Connect circuit, you can use the host instead of an ECS instance.

  • An OSS bucket is created. For more information, see Get started with the OSS console.

    Important
    • File gateways support Standard, Infrequent Access (IA), and Archive OSS buckets. Buckets with mirroring-based back-to-origin are not supported.

    • Do not associate a gateway with an Archive bucket. Instead, store files in a Standard or IA bucket and configure a lifecycle rule to transition them to Archive or Cold Archive. This avoids unnecessary restoration operations.

    • When a client writes a file, the gateway calls CopyObject to store the file modification time as object metadata. For Archive or Cold Archive objects, CopyObject triggers restoration, which slows uploads and may cause upload failures.

Create a file gateway

  1. Go to the Gateways page of the CSG console and click Create.

  2. In the Create Gateway wizard, configure the parameters described in the following table and retain default settings for other parameters.

    Example

    Step

    Parameter

    Description

    Gateway Information

    Name

    Enter a gateway name. The name must be 1 to 60 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a letter.

    Location

    Select Alibaba Cloud.

    Type

    Select File Gateway.

    Region

    Select the region where you want to deploy the file gateway.

    Gateway Configurations

    VPC

    Select the VPC in which you want to deploy the gateway.

    Note

    The VPC must be the same one where your ECS instance or on-premises host resides.

    VSwitch

    Select the vSwitch to which the gateway connects.

    Note
    • The vSwitch must be the same one to which your ECS instance or on-premises host connects.

    • If no gateway resources are available in the zone of the selected vSwitch, create a vSwitch in a different zone.

    Edition

    Select Basic, Standard, Enhanced, or Performance Optimized. For more information, see Specifications.

    Config Protocol

    Cross-region Binding

    • Yes: Allows access to buckets in different regions.

    • No: Restricts access to buckets within the same region as the gateway.

    OSS Endpoint

    Select the endpoint for the region where the bucket resides.

    Bucket Name

    Select an existing bucket from the drop-down list. To map the share to a subdirectory, select the Subdirectory check box and enter the subdirectory path.

    • The name of a subdirectory can contain only letters and digits.

    • From V1.0.38 onwards, the root directory of the file system can be mapped to an OSS bucket subdirectory for access isolation.

    • The subdirectory can be an existing or new directory in the OSS bucket. After the share is created, this subdirectory serves as the root directory and stores all related files and directories.

    • File gateways do not support OSS buckets with back-to-origin routing configured.

    • Buckets with retention policies are not supported because CSG cannot guarantee single-write operations on objects.

    Public Network Bandwidth

    Specify the public bandwidth. This parameter is available only when Cross-region Binding is set to Yes. The default bandwidth is 5 Mbit/s. Increase the bandwidth for better data transfer performance.

    Note
    • To use the gateway or the express synchronization feature across regions, configure this parameter. For more information, see Configure a public bandwidth limit.

    • The public bandwidth ranges from 5 Mbit/s to 200 Mbit/s.

    Protocol

    Select the protocol for connecting to the OSS bucket: NFS or SMB.

    • Select NFS to access the bucket from a Linux system.

    • Select SMB to access the bucket from a Windows system.

    Share Name

    Enter a name for the share. If Protocol is set to NFS, the share name also serves as the virtual path for NFSv4 mount operations.

    Note

    The name must be 1 to 32 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a letter.

    User Mapping

    Configure the user mapping between the NFS client and the NFS server. This parameter is available only when Protocol is set to NFS. Valid values:

    • none: NFS client users are not mapped to the nobody user on the NFS server.

    • root_squash: The root user on the NFS client is mapped to the nobody user on the NFS server.

    • all_squash: All NFS client users are mapped to the nobody user on the NFS server.

    • all_anonymous: All NFS client users are mapped to the anonymous user on the NFS server.

    Reverse Sync

    Specify whether to synchronize object metadata from the bucket to your local device. Reverse synchronization is useful for disaster recovery, data recovery, and data sharing.

    Note

    During reverse synchronization, the system scans all objects in the bucket. If the bucket contains a large number of objects, OSS API call fees apply. For more information, see Pricing.

    Reverse Sync Interval

    Required when Reverse Sync is set to Yes. Valid values: 15 to 36000. Unit: seconds.

    Note

    For buckets with a large number of objects, set the interval to a value greater than 3,600 seconds. Otherwise, frequent scans increase OSS API call fees.

    Cache Disk Type

    Select Ultra Disk, Standard SSD, or ESSD based on your requirements.

    Cache Capacity

    • The capacity of a cache disk for a Basic gateway ranges from 40 GB to 4,096 GB.

    • The capacity of a cache disk for a Standard gateway ranges from 40 GB to 8,192 GB.

    • The capacity of a cache disk for an Enhanced or Performance Optimized gateway ranges from 40 GB to 32,768 GB.

    Billing Information

    Billing Method

    Select Pay-as-you-go or Subscription. For more information, see Billing.

    If you select Subscription, you are redirected to the subscription purchase page after you create the file gateway. Complete the payment.

    Expiration Policy

    Expiration policy for the gateway subscription. Select Switch to Pay-as-you-go or Release.

  3. In the Confirmation step, verify the configuration and click Completed.

Important
  • After the gateway is created, the system automatically deploys and starts the gateway. This process takes approximately 5 to 10 minutes. The gateway enters the Running state after successful activation and deployment.

  • The share configured during gateway creation is also created. To create a different share, see Attach a cache disk and Create a share.

Related operations

The Gateway List page also supports the following operations.

Operation

Description

Delete a gateway

Locate the file gateway and click Delete.

Note
  • Only pay-as-you-go file gateways can be deleted.

  • Before deleting a gateway with an NFS share, unmount the share on the client first.

    If the share or gateway is deleted without unmounting it from the client, the mount target cannot be unmounted properly. Subsequent operations on the mounted directory will hang or become unresponsive.

Rename a gateway

Locate the file gateway and choose More > Edit to rename the gateway.

Switch to a subscription

After creating a pay-as-you-go gateway, switch its billing method to subscription.

Choose More > Switch to Subscription and purchase as needed. For more information, see Switch from pay-as-you-go to subscription.

Important

Do not modify any configuration information except for the billing cycle.

Upload support data

Choose More > Upload Support Data to upload gateway logs for troubleshooting.

Complete payment

For a subscription gateway with pending payment, choose More > Purchase to return to the purchase page and complete the payment.

Change expiration policy

For a subscription gateway, choose More > Change Expiration Policy to change the expiration policy. For more information, see Switch an expiration policy.

What to do next

Add a cache

Create a share