# Alibaba Cloud Cloud Storage Gateway API

> Alibaba Cloud Cloud Storage Gateway API on Apizie: 69 endpoints (Adds one or more shares to an express synchronization group, Creates an express synchronization group, Creates a subscription or pay-as-you-go gateway, Creates a block volume (iSCSI) for an iSCSI gateway, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-sgw/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-sgw`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/sgw
- Page: https://zieapi.vercel.app/api/cloud/aliyun-sgw
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-sgw/openapi.json

Alibaba Cloud OpenAPI for Cloud Storage Gateway (sgw, version 2018-05-11). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds one or more shares to an express synchronization group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/add-shares-to-express-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExpressSyncId | string | yes | The ID of the express synchronization group |
| GatewayShares | string | yes | The names of gateway shares. You can add multiple shares. The value must be a JSON string that is in the following format: {"Gateway… |

### Creates an express synchronization group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-express-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the express synchronization group. The name must be 1 to 128 characters in length and can contain letters, Chinese characters,… |
| Description | string | no | The description of the express synchronization group. The description can be up to 255 characters in length |
| BucketRegion | string | yes | The region where the OSS bucket is located |
| BucketName | string | yes | The name of the bucket. Note: You can specify only one OSS bucket for a synchronization group. All data changes in the bucket are… |
| BucketPrefix | string | no | The prefix of the subdirectory in the bucket. If you want to synchronize data changes in a specific subdirectory of the bucket, you can… |

### Creates a subscription or pay-as-you-go gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StorageBundleId | string | no | The ID of the gateway cluster. You must specify this parameter if you do not specify ResourceRegionId |
| Name | string | yes | The name of the gateway. The name must be 60 characters in length. The name must start with a letter or a Chinese character. The name can… |
| Description | string | no | The description of the gateway. The description can be 0 to 255 characters in length |
| Category | string | no | The category of the gateway. The default value is `Aliyun` |
| Type | string | yes | The type of the gateway. Valid values: File: file gateway. Iscsi: iSCSI gateway |
| Location | string | yes | The location of the gateway. Valid values: Cloud: cloud gateway. On_Premise: on-premises gateway |
| GatewayClass | string | no | The gateway class. This parameter is related to fees. For more information, see Billable items and billing methods… |
| VSwitchId | string | no | The ID of the virtual switch. If your gateway is deployed in a data center, you can ignore this parameter. The vSwitch must be in the same… |
| PostPaid | string | no | The billing method of the gateway. This parameter is related to fees. For more information, see Billable items and billing methods… |
| ReleaseAfterExpiration | string | no | Specifies whether to release the gateway when the subscription expires. Valid values: true: The gateway is automatically released. false:… |
| PublicNetworkBandwidth | integer | no | The public bandwidth for data transmission. Unit: Mbit/s. Valid values: 5 to 200. This parameter is related to fees. For more information,… |
| ResourceRegionId | string | no | The ID of the resource region |
| UntrustedEnvInstanceType | string | no | The actual gateway class in an untrusted environment (CloudBox… |
| UntrustedEnvId | string | no | The ID of the instance in an untrusted environment (CloudBox… |
| SecondaryVSwitchId | string | no | The ID of the vSwitch for the secondary node of the high-availability (HA) gateway |

### Creates a block volume (iSCSI) for an iSCSI gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway-block-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| Name | string | yes | The name of the block volume. The name must be 1 to 32 characters in length, start with a lowercase letter, and can contain lowercase… |
| Recovery | string | no | Specifies whether to enable recovery for the block volume. If you enable recovery and the specified OSS bucket was previously used as the… |
| VolumeProtocol | string | yes | The protocol of the block volume. The only valid value is iSCSI |
| Size | integer | no | The size of the block volume. Unit: GB. Valid values: 1 to 262144. Default value: 100. This parameter is invalid when recovery is enabled |
| ChunkSize | integer | no | The storage allocation unit of the block volume. This parameter specifies the minimum allocation unit of the block volume. To achieve… |
| CacheMode | string | no | The cache mode of the block volume. Default value: Cache. Valid values: Cache: cache mode. WriteThrough: write-through mode. You must… |
| ChapEnabled | string | no | Specifies whether to enable Challenge-Handshake Authentication Protocol (CHAP) for iSCSI access. Inbound CHAP is supported. Default value:… |
| ChapInUser | string | no | The username for inbound CHAP when CHAP is enabled for the block volume. The username must be 1 to 32 characters in length and can contain… |
| ChapInPassword | string | no | The password for inbound CHAP when CHAP is enabled for the block volume. The password must be 12 to 16 characters in length and can… |
| OssBucketName | string | yes | The name of the Object Storage Service (OSS) bucket that corresponds to the block volume. Block volumes do not support OSS buckets for… |
| OssEndpoint | string | yes | The endpoint of the region where the OSS bucket that corresponds to the block volume is located. Differentiate between internal and public… |
| OssBucketSsl | string | no | Specifies whether to enable SSL to access the OSS bucket. Default value: true |
| LocalFilePath | string | no | The internal device name of the cache disk used by the block volume. You can call the DescribeGatewayCaches operation to obtain the name.… |
| OssBucketRegionId | string | no | The region where the OSS bucket that corresponds to the block volume is located |

### Creates a cache disk for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway-cache-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| CacheDiskCategory | string | no | The type of the cache disk. Only Enhanced SSDs (ESSDs) are supported. Set the value to cloud_essd |
| CacheDiskSizeInGB | integer | yes | The capacity of the cache disk in GB. The capacity must meet the following requirements: For a basic gateway, the capacity must be in the… |
| PerformanceLevel | string | no | The performance level of the ESSD. This parameter is required if CacheDiskCategory is set to cloud_essd. Valid values: PL1 PL2 PL3 |

### Creates a file share on a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway-file-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| Name | string | yes | The name of the file share. The name must be 1 to 255 characters in length and can contain uppercase and lowercase letters, digits,… |
| ShareProtocol | string | yes | The file share protocol. Valid values: NFS SMB |
| RemoteSync | string | no | Specifies whether reverse synchronization is enabled for the file share. Valid values: false (default): no true: yes |
| PollingInterval | integer | no | The reverse synchronization interval for the file share. Valid values: 15 to 36000. If replication mode and reverse synchronization with… |
| IgnoreDelete | string | no | Specifies whether delete operations are ignored for the file share. If this feature is enabled, deleting a file on the gateway does not… |
| FrontendLimit | integer | no | The maximum write speed of the file share. Unit: MB/s. Valid values: 0 to 1280. Default value: 0, which indicates no limit |
| BackendLimit | integer | no | The maximum upload speed of the file share. Unit: MB/s. Valid values: 0 to 1280. Default value: 0, which indicates no limit. If the… |
| InPlace | string | no | [Deprecated] This parameter is deprecated. Do not set this parameter |
| CacheMode | string | no | The cache mode of the file share. Valid values: Cache: cache mode Sync: replication mode |
| Browsable | string | no | Specifies whether the file share is browsable over the SMB protocol, which means whether it can be discovered in Network Neighborhood.… |
| Squash | string | no | The user mapping for the file share over the NFS protocol. Valid values: none (default) root_squash all_squash all_anonymous |
| ReadWriteUserList | string | no | The list of users who have read and write permissions on the file share over the SMB protocol. Separate multiple users with commas (,).… |
| ReadOnlyUserList | string | no | The list of users who have read-only permissions on the file share over the SMB protocol. Separate multiple users with commas (,). This… |
| ReadWriteClientList | string | no | The list of clients that have read and write permissions on the file share over the NFS protocol. You can specify IP addresses or IP… |
| ReadOnlyClientList | string | no | The list of clients that have read-only permissions on the file share over the NFS protocol. You can specify IP addresses or IP address… |
| OssBucketName | string | yes | The name of the OSS bucket that corresponds to the file share. File shares do not support OSS buckets of the Cold Archive storage class or… |
| OssEndpoint | string | yes | The endpoint of the region where the OSS bucket that corresponds to the file share is located. You can use an internal network or public… |
| OssBucketSsl | string | no | Specifies whether SSL access to the OSS bucket is enabled for the file share. Valid values: true (default): yes false: no |
| LagPeriod | integer | no | The synchronization latency, which is the delay for synchronizing data from the local cache of the gateway to OSS. Unit: seconds. Valid… |
| DirectIO | string | no | [Deprecated] This parameter is deprecated |
| LocalFilePath | string | yes | The internal device name of the cache disk used by the file share. You can call the DescribeGatewayCaches operation to obtain the device… |
| ServerSideEncryption | string | no | [Deprecated] This parameter is deprecated |
| ServerSideCmk | string | no | [Deprecated] This parameter is deprecated |
| ClientSideEncryption | string | no | [Deprecated] This parameter is deprecated |
| ClientSideCmk | string | no | [Deprecated] This parameter is deprecated |
| KmsRotatePeriod | integer | no | [Deprecated] This parameter is deprecated |
| PathPrefix | string | no | The subdirectory path in the OSS bucket that corresponds to the file share. If this parameter is left empty, the root directory of the… |
| FastReclaim | string | no | Specifies whether upload optimization is enabled for the file share. This feature is suitable for scenarios where data is used for pure… |
| SupportArchive | string | no | [Deprecated] This parameter is deprecated. Do not set this parameter |
| WindowsAcl | string | no | Specifies whether permission control by using Windows access control lists (ACLs) is enabled for the file share over the SMB protocol.… |
| AccessBasedEnumeration | string | no | Specifies whether Windows access-based enumeration (ABE) is enabled for the file share over the SMB protocol. This feature takes effect… |
| NfsV4Optimization | string | no | Specifies whether NFS v4 optimization is enabled for the file share over the NFS protocol to improve the efficiency of mounting and… |
| TransferAcceleration | string | no | Specifies whether the transfer acceleration feature is enabled for the file share. This feature requires that transfer acceleration is… |
| RemoteSyncDownload | string | no | Specifies whether to download file data in replication mode. Valid values: false (default): no true: yes This parameter takes effect only… |
| DownloadLimit | integer | no | The maximum download speed of the file share. Unit: MB/s. Valid values: 0 to 1280. A value of 0 indicates no limit. This parameter can be… |
| PartialSyncPaths | string | no | The collection of directory paths that use replication mode. Only the specified directories use replication mode. To configure this… |
| ServerSideAlgorithm | string | no | [Deprecated] This parameter is deprecated |
| BypassCacheRead | string | no | Specifies whether to read data directly from OSS. Valid values: true: yes false (default): no |
| BindIPAddr | string | no | The virtual mount IP address bound to the share. This parameter is used only for high-availability gateways |
| OssBucketRegionId | string | no | The region where the OSS bucket that corresponds to the file share is located. If the gateway version is 2.0.0 or later and this parameter… |
| BucketInfos | string | no | [Deprecated] This parameter is deprecated (JSON-encoded) |
| BucketStub | string | no | Specifies whether to enable multi-bucket aggregation. A value of false indicates that multi-bucket aggregation is disabled |

### Enables log monitoring for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| SlsProject | string | yes | The SLS project |
| SlsLogstore | string | yes | The SLS Logstore |

### Adds an SMB user to a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-gateway-smbuser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| Username | string | yes | The username of the SMB user. The username must be 1 to 32 characters in length and can contain letters, digits, hyphens (-), and… |
| Password | string | yes | The password of the SMB user. The password cannot be empty. The password can contain letters, digits, and the following special… |

### Creates a gateway cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/create-storage-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the gateway cluster. The name must be 1 to 60 characters in length and can contain uppercase letters, lowercase letters,… |
| Description | string | no | The description of the gateway cluster. The description can be 0 to 128 characters in length |
| BackendBucketRegionId | string | yes | The region where the gateway cluster is located. You can call the DescribeRegions operation to obtain a valid region ID |

### Deletes a specified express synchronization group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-express-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExpressSyncId | string | yes | The ID of the express synchronization group |

### Deletes a pay-as-you-go gateway from its cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| ReasonType | string | no | The type of the reason why you want to delete the gateway. Valid values: REASON1: The gateway fee is too high. REASON2: The gateway is… |
| ReasonDetail | string | no | The detailed reason why you want to delete the gateway |

### Deletes the specified iSCSI gateway block volumes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway-block-volumes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The ID of the index. You can call the DescribeGatewayBlockVolumes operation to query the ID |
| IsSourceDeletion | string | no | Specifies whether to delete the source data. Valid values: true: When the iSCSI gateway volume is deleted, the data in the OSS bucket is… |

### Deletes a cache disk from a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway-cache-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| CacheId | string | yes | The ID of the cache disk. You can call the DescribeGatewayCaches operation to query the ID of the cache disk |
| LocalFilePath | string | yes | The name of the device that corresponds to the cache disk. You can call the DescribeGatewayCaches operation to query the name of the device |

### Deletes one or more file shares from a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway-file-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The ID of the file share. You can call the DescribeGatewayFileShares operation to query the IDs of file shares |
| Force | string | no | Specifies whether to force delete the file share. Valid values: true: Force deletes the file share even if data synchronization is… |

### Deletes the log monitoring feature for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Deletes a specified Server Message Block (SMB) user from a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-gateway-smbuser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| Username | string | yes | The SMB username. The username must be 1 to 32 characters in length and can contain letters, digits, hyphens (-), and underscores (_) |

### If the gateway cluster contains online or on-premises Cloud Storage Gateways, you must delete all gateways…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/delete-storage-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StorageBundleId | string | yes | The ID of the gateway cluster |

### You can call the DeployGateway operation to deploy a pay-as-you-go gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/deploy-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| GatewayClass | string | no | The gateway class. Valid values: Basic Standard Enhanced Advanced |

### Queries the account configuration information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-account-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | no | [Deprecated] |

### Queries for shares that are associated with an express synchronization group or can be added to the group.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-express-sync-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExpressSyncIds | string | yes | A list of express synchronization group IDs. The IDs are separated by commas |
| IsExternal | string | no | Specifies whether to query the shares that have been added to the express synchronization group. Valid values: true: queries the… |

### Queries the details of express synchronization groups, including their names, IDs, and bucket names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-express-syncs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BucketName | string | no | The name of the bucket. If you do not specify this parameter, all express synchronization groups that belong to the current user are queried |
| BucketPrefix | string | no | The subdirectory of the bucket. If you do not specify this parameter, the express synchronization groups of the bucket are queried. If you… |

### Queries the basic information of a specified gateway, including details such as the gateway status and type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Queries information about the AD server configured for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-adinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### Queries details about iSCSI gateway volumes, such as operation status, data transfer, address, capacity,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-block-volumes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | no | The index ID. If this parameter is left empty, the configurations of all iSCSI gateway volumes on the gateway are enumerated |
| Refresh | string | no | Specifies whether to forcibly refresh the cache. Valid values: true (default): yes. false: no |

### Queries information about cache disks, such as size and type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-caches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### Queries the available gateway categories
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayLocation | string | no | This parameter is required. The location of the gateway. Valid values: Cloud: an online gateway. On_Premise: an on-premises gateway |

### Queries available gateway editions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-classes` (byok)

### You can call the DescribeGatewayDNS operation to query the DNS servers that are configured on a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### Describes the configurations of file shares on a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-file-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | no | The ID of the file share. If you leave this parameter empty, the configurations of all file shares on the gateway are returned |
| Refresh | string | no | Specifies whether to forcibly refresh the cache. The default value is false |

### Queries the status of a single file in a file gateway's file share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-file-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The ID of the file share. You can call the DescribeGatewayFileShares operation to obtain the ID |
| FilePath | string | yes | The path of the file |

### Queries information about on-premises gateway images, including the names and descriptions of the images
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Type | string | yes | The type of the gateway. Valid values: File: file gateway. Iscsi: block gateway |

### Returns a list of gateway locations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-locations` (byok)

### Queries the logging configurations of a gateway, including the logging status, Simple Log Service (SLS)…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Queries the instance types to which a gateway can be upgraded
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-modification-classes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### Queries the NFS clients for a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-nfsclients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries to return on each page |

### Queries the Server Message Block (SMB) clients of a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-smbclients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the SMB security level configuration of a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-smbsecurity-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Queries the list of SMB usernames on a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-smbusers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| PageNumber | integer | no | The page number to return for a paged query. Start value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10 |

### Queries the available gateway types for a specified location
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateway-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayLocation | string | yes | The location of the gateway. Valid values: Cloud: a cloud gateway. On_Premise: an on-premises gateway |

### Queries a list of gateways and returns their IDs and names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StorageBundleId | string | no | The ID of the gateway cluster. If you do not specify ResourceRegionId, you must specify this parameter |
| PageNumber | integer | no | The page number of the gateway list. Start value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10 |
| ResourceRegionId | string | no | The ID of the region where the resource resides |

### You can call the DescribeRegions operation to query the valid regions for gateways
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-regions` (byok)

### Queries information about a gateway cluster, including its region, timestamp, name, and description
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-storage-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StorageBundleId | string | yes | The ID of the gateway cluster |

### Queries information about storage bundles, including their names, descriptions, and creation time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-storage-bundles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BackendBucketRegionId | string | yes | The region where the gateway cluster resides. You can call the DescribeRegions operation to obtain a valid region ID |
| PageNumber | integer | no | The page number of the gateway cluster list. Start value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10 |

### Queries task information, including task progress and name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/describe-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TargetId | string | yes | The ID of the gateway or express synchronization group |
| PageNumber | integer | no | The page number. Page starts from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. Default value: 10 |
| TaskId | string | no | The task ID. If you leave the parameter empty, all tasks are queried |

### Disables the log monitoring feature for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/disable-gateway-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Enables log monitoring for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/enable-gateway-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### Expands the cache disk of a Cloud Storage Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/expand-cache-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| NewSizeInGB | integer | yes | The capacity of the cache disk after it is scaled out. Unit: GB. The following requirements must be met: The capacity of the cache disk… |
| LocalFilePath | string | yes | The internal device name of the cache disk. You can call the DescribeGatewayCaches operation to query the internal device name of the… |

### Increases the capacity of a share for an on-premises gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/expand-gateway-file-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | no | The gateway ID |
| IndexId | string | no | The ID of the share. You can call the DescribeGatewayFileShares operation to query the share ID |

### Expands the public bandwidth of a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/expand-gateway-network-bandwidth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| NewNetworkBandwidth | integer | no | The new network bandwidth. Unit: Mbit/s. Valid values: a value that is greater than the current bandwidth up to 200. This parameter is… |

### Lists alert events for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/list-alert-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | no | The ID of the gateway |
| ShareIndexId | string | no | The share name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| FirstTriggerTimestampStartTime | integer | no | The start timestamp |
| FirstTriggerTimestampEndTime | integer | no | The end timestamp |
| GatewayRegionId | string | no | The ID of the region where the gateway is located |
| Status | string | no | The status of the alert events. If you set this parameter to alerting, only the events that are being triggered are listed. If you do not… |

### Lists the tags attached to one or more gateways
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the most recent region list |
| ResourceRegionId | string | no | The ID of the resource region |
| ResourceType | string | yes | The resource type. The value must be GATEWAY |
| NextToken | string | no | The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. If the… |
| ResourceId | string | no | The IDs of gateways. You can query the tags of N gateways at a time. You must specify at least one of ResourceId and Tag (JSON-encoded) |
| Tag | string | no | The tags. You must specify at least one of ResourceId and Tag (JSON-encoded) |

### Modifies a specified gateway's basic information, including its name and description
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/modify-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| Name | string | yes | The new name of the gateway. The name must be 1 to 60 characters in length. It can contain uppercase letters, lowercase letters, Chinese… |
| Description | string | no | The new description of the gateway. The description can be 0 to 255 characters in length |

### Upgrades the gateway class of an online gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/modify-gateway-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| GatewayClass | string | yes | The gateway class to which you want to upgrade. You can call the DescribeGatewayModificationClasses operation to query the available… |

### Modifies the watermark for a gateway file share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/modify-gateway-file-share-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The ID of the file share. You can obtain the ID by calling the DescribeGatewayFileShares operation |
| Watermark | integer | yes | The watermark. The value must be within the following range: Minimum value: 40. Maximum value: 90 |

### Modifies the basic information of a specified gateway cluster, such as its name and description
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/modify-storage-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StorageBundleId | string | yes | The ID of the gateway cluster |
| Name | string | yes | The name of the gateway cluster. The name must be 1 to 60 characters in length. It can contain letters, Chinese characters, digits,… |
| Description | string | no | The description of the gateway cluster. The description cannot exceed 128 characters in length |

### Activates the gateway service. The service must be activated before you can use the product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/open-sgw-service` (byok)

### You can call the RemoveSharesFromExpressSync operation to delete multiple shares from an express…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/remove-shares-from-express-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExpressSyncId | string | yes | The ID of the express synchronization group |
| GatewayShares | string | yes | The names of the gateway shares. You can delete multiple shares. The JSON format is: {"Gateway ID 1":"Share 1,Share 2","Gateway ID… |

### Restarts file shares on a Cloud Storage Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/restart-file-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| ShareProtocol | string | yes | The file sharing protocol. Valid values: SMB NFS |

### Sets or purges the AD server information for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/set-gateway-adinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| Username | string | no | The username that is used to connect to the AD server. Valid values: If IsEnabled is set to false, you can leave this parameter empty. If… |
| Password | string | no | The password that is used to connect to the AD server. Valid values: If IsEnabled is set to false, you can leave this parameter empty. If… |
| ServerIp | string | no | The IP address of the AD server. Valid values: If IsEnabled is set to false, you can leave this parameter empty. If IsEnabled is set to… |
| IsEnabled | string | no | Specifies whether to enable the AD server. Valid values: true: enables the AD server. false (default): purges the AD server information.… |

### Adds DNS server information to a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/set-gateway-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| DnsServer | string | yes | The IP addresses of the DNS servers. If you specify multiple IP addresses, separate them with commas |

### Configures the SMB security level
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/set-gateway-smbsecurity-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| SecurityStrategy | string | no | The security level. Valid values: ClientNegotiated: Client negotiation. EnforceSigning: Enforced signing |
| SmbEncryptStrategy | string | no | The SMB encryption level. Valid values: ClientNegotiated: Client negotiation. EnforceEncryption: Enforced encryption (AES-128-CCM) |

### Creates tags and attaches the tags to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query region IDs |
| ResourceRegionId | string | no | The region ID of the resource |
| ResourceType | string | yes | The type of the resource. Valid value: GATEWAY |
| Tag | string | yes | The tag information (JSON-encoded) |
| ResourceId | string | yes | The list of gateway IDs. You can attach tags to N gateways at a time. Valid values of N: 1 to 50 (JSON-encoded) |

### Actively triggers a file gateway to perform a reverse synchronization on the specified path
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/trigger-gateway-remote-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |
| IndexId | string | yes | The ID of the share |
| Path | string | no | The path on which you want to trigger reverse synchronization |

### Detaches tags from a specified gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region list |
| ResourceRegionId | string | no | The region ID of the resource |
| ResourceType | string | yes | The resource type. The value must be GATEWAY |
| All | string | no | Specifies whether to remove all tags from the instance. The default value is false. Valid values: true. false |
| ResourceId | string | yes | The list of resource IDs (JSON-encoded) |
| TagKey | string | no | The tag key. If the All parameter is not specified or is set to false, you must specify TagKey (JSON-encoded) |

### Updates the configuration of a block volume on an iSCSI gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/update-gateway-block-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The index ID. You can call the DescribeGatewayBlockVolumes operation to query the index ID |
| Size | integer | no | The size of the block volume. Unit: GB. Valid values: 1 to 262144. Default value: 100. This parameter is invalid when recovery is enabled |
| ChapEnabled | string | no | Specifies whether to enable Challenge-Handshake Authentication Protocol (CHAP) authentication for the iSCSI volume. Inbound CHAP is… |
| ChapInUser | string | no | The username for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The username must be 1 to 32… |
| ChapInPassword | string | no | The password for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The password must be 12 to 16… |

### This operation updates the configuration of a file share for a file gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/update-gateway-file-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |
| IndexId | string | yes | The ID of the file share. Call the DescribeGatewayFileShares operation to obtain the ID |
| Name | string | yes | The name of the file share. Call the DescribeGatewayFileShares operation to obtain the name. This parameter cannot be modified |
| RemoteSync | string | no | Specifies whether to enable remote sync for the file share. Valid values: false (default): No. true: Yes |
| RemoteSyncDownload | string | no | Specifies whether to download file data in replication mode. This parameter is available for file gateways that run version 1.2.0 or… |
| PollingInterval | integer | no | The remote sync interval, in seconds. This parameter is required if you enable remote sync. Valid values: 15 to 36000. If the file share… |
| IgnoreDelete | string | no | Specifies whether to ignore file deletions. If this feature is enabled, deleting a file on the gateway does not delete the corresponding… |
| FrontendLimit | integer | no | The maximum write speed of the file share, in MB/s. Valid values: 0 to 1280. A value of 0 indicates no limit |
| BackendLimit | integer | no | The maximum upload speed of the file share, in MB/s. Valid values: 0 to 1280. A value of 0 indicates no limit. If you also set… |
| DownloadLimit | integer | no | The maximum download speed of the file share, in MB/s. Valid values: 0 to 12800. A value of 0 indicates no limit. This parameter can be… |
| InPlace | string | no | This parameter is deprecated. Do not set this parameter |
| CacheMode | string | no | The cache mode of the file share. Call the DescribeGatewayFileShares operation to obtain the cache mode. This parameter cannot be modified |
| Browsable | string | no | Specifies whether the file share is browsable over the SMB protocol. A browsable file share can be discovered in Network Neighborhood.… |
| Squash | string | no | The user mapping for the file share over the NFS protocol. The default value is none. Valid values: none root_squash all_squash… |
| ReadWriteUserList | string | no | The list of users who have read and write permissions on the file share over the SMB protocol. Separate multiple users with commas (,).… |
| ReadOnlyUserList | string | no | The list of users who have read-only permissions on the file share over the SMB protocol. Separate multiple users with commas (,). This… |
| ReadWriteClientList | string | no | The list of clients that have read and write permissions on the file share over the NFS protocol. The clients can be IP addresses or IP… |
| ReadOnlyClientList | string | no | The list of clients that have read-only permissions on the file share over the NFS protocol. The clients can be IP addresses or IP address… |
| LagPeriod | integer | no | The synchronization latency, in seconds. This is the delay for synchronizing the gateway's local cache with OSS. Valid values: 5 to 120.… |
| DirectIO | string | no | Specifies whether to enable Direct I/O (DirectIO) for data transfer on the file share. Valid values: false (default): No. true: Yes |
| ServerSideEncryption | string | no | Deprecated |
| ServerSideCmk | string | no | Deprecated |
| ClientSideEncryption | string | no | Deprecated |
| ClientSideCmk | string | no | Deprecated |
| KmsRotatePeriod | integer | no | Deprecated |
| FastReclaim | string | no | Specifies whether to enable upload optimization for the file share. This feature is suitable for scenarios where data is only backed up to… |
| WindowsAcl | string | no | Specifies whether to enable access control through a Windows access control list (ACL) over the SMB protocol. This feature requires an… |
| AccessBasedEnumeration | string | no | Specifies whether to enable Windows access-based enumeration (ABE) over the SMB protocol. This parameter takes effect only when the… |
| NfsV4Optimization | string | no | Specifies whether to enable NFSv4 optimization to improve mount and upload efficiency over the NFS protocol. Valid values: false… |
| TransferAcceleration | string | no | Specifies whether to enable transfer acceleration for the file share. The corresponding OSS bucket must also have transfer acceleration… |
| BypassCacheRead | string | no | Specifies whether to enable direct OSS reads for the file share. If enabled, data is read directly from OSS without passing through the… |
| ServerSideAlgorithm | string | no | Deprecated |

### Updates a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/upgrade-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The gateway ID |

### Uploads gateway diagnostic information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/upload-gateway-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GatewayId | string | yes | The ID of the gateway |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-sgw/add-shares-to-express-sync" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Storage Gateway API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-sgw/add-shares-to-express-sync with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud Storage Gateway API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Storage Gateway itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Cloud Storage Gateway API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sgw.

### What is the status of the Alibaba Cloud Cloud Storage Gateway API?
Needs your own provider key (bring your own key)