API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (sgw/2018-05-11) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Gateway clusters
|
API |
Title |
Description |
| CreateStorageBundle | CreateStorageBundle | Creates a gateway cluster. |
| ModifyStorageBundle | ModifyStorageBundle | Modifies the basic information of a specified gateway cluster, such as its name and description. |
| DescribeStorageBundle | DescribeStorageBundle | Queries information about a gateway cluster, including its region, timestamp, name, and description. |
| DeleteStorageBundle | DeleteStorageBundle | If the gateway cluster contains online or on-premises Cloud Storage Gateways, you must delete all gateways before you can delete the cluster. |
| DescribeStorageBundles | DescribeStorageBundles | Queries information about storage bundles, including their names, descriptions, and creation time. |
Gateways
|
API |
Title |
Description |
| OpenSgwService | OpenSgwService | Activates the gateway service. The service must be activated before you can use the product. |
| ModifyGateway | ModifyGateway | Modifies a specified gateway's basic information, including its name and description. |
| DeployGateway | DeployGateway | You can call the DeployGateway operation to deploy a pay-as-you-go gateway. |
| DescribeGateways | DescribeGateways | Queries a list of gateways and returns their IDs and names. |
| DescribeGatewayCategories | DescribeGatewayCategories | Queries the available gateway categories. |
| DescribeGatewayTypes | DescribeGatewayTypes | Queries the available gateway types for a specified location. |
| DescribeAccountConfig | DescribeAccountConfig | Retrieves the configuration of an account. |
| DescribeGatewayImages | Query on-premises gateway image information | Queries information about on-premises gateway images, including the names and descriptions of the images. |
| TriggerGatewayRemoteSync | TriggerGatewayRemoteSync | Actively triggers a file gateway to perform a reverse synchronization on the specified path. |
| DescribeGatewayClasses | DescribeGatewayClasses | Queries available gateway editions. |
| ExpandGatewayNetworkBandwidth | ExpandGatewayNetworkBandwidth | Expands the public bandwidth of a gateway. |
Block volumes
|
API |
Title |
Description |
| CreateGatewayBlockVolume | CreateGatewayBlockVolume | Creates a block volume (iSCSI) for an iSCSI gateway. |
| DescribeGatewayBlockVolumes | DescribeGatewayBlockVolumes | Queries details about iSCSI gateway volumes, such as operation status, data transfer, address, capacity, port, CHAP, OSS Bucket SSL, LUN ID, and volume status. |
| UpdateGatewayBlockVolume | UpdateGatewayBlockVolume | Updates the configuration of a block volume on an iSCSI gateway. |
| DeleteGatewayBlockVolumes | DeleteGatewayBlockVolumes | Deletes the specified iSCSI gateway block volumes. |
Cache disks
|
API |
Title |
Description |
| CreateGatewayCacheDisk | CreateGatewayCacheDisk | Creates a cache disk for a gateway. |
| DescribeGatewayCaches | DescribeGatewayCaches | Queries information about cache disks, such as size and type. |
| ExpandCacheDisk | ExpandCacheDisk | Expands the cache disk of a Cloud Storage Gateway. |
| DeleteGatewayCacheDisk | DeleteGatewayCacheDisk | Deletes a cache disk from a file gateway. |
Log monitoring
|
API |
Title |
Description |
| CreateGatewayLogging | CreateGatewayLogging | Enables log monitoring for a gateway. |
| DescribeGatewayLogging | DescribeGatewayLogging | Queries the logging configurations of a gateway, including the logging status, Simple Log Service (SLS) project name, and Logstore name. |
| EnableGatewayLogging | EnableGatewayLogging | Enables log monitoring for a gateway. |
| DisableGatewayLogging | DisableGatewayLogging | Disables the log monitoring feature for a gateway. |
| DeleteGatewayLogging | DeleteGatewayLogging | Deletes the log monitoring feature for a gateway. |
Express synchronization groups
|
API |
Title |
Description |
| CreateExpressSync | CreateExpressSync | Creates an express synchronization group. |
| AddSharesToExpressSync | AddSharesToExpressSync | Adds one or more shares to an express synchronization group. |
| DescribeExpressSyncs | DescribeExpressSyncs | Queries the details of express synchronization groups, including their names, IDs, and bucket names. |
| DescribeExpressSyncShares | DescribeExpressSyncShares | Queries for shares that are associated with an express synchronization group or can be added to the group. The returned information includes details such as the gateway name, cluster ID, and share name. |
| DeleteExpressSync | DeleteExpressSync | Deletes a specified express synchronization group. |
| RemoveSharesFromExpressSync | RemoveSharesFromExpressSync | You can call the RemoveSharesFromExpressSync operation to delete multiple shares from an express synchronization group. |
Others
|
API |
Title |
Description |
| DescribeGatewayLocations | DescribeGatewayLocations | Returns a list of gateway locations. |
| DescribeGatewaySMBClients | DescribeGatewaySMBClients | Queries the Server Message Block (SMB) clients of a file gateway. |
| DescribeGatewaySMBSecurityStrategy | DescribeGatewaySMBSecurityStrategy | Queries the Server Message Block (SMB) security level configuration of a gateway. |
| SetGatewaySMBSecurityStrategy | SetGatewaySMBSecurityStrategy | Sets the Server Message Block (SMB) security level for a gateway. |
| CreateGateway | CreateGateway | Creates a subscription or pay-as-you-go gateway. |
| DeleteGateway | DeleteGateway | Deletes a pay-as-you-go gateway from its cluster. |
| DescribeGateway | DescribeGateway | Queries basic information about a gateway, such as its status and type, based on the specified gateway ID. |
| DescribeGatewayModificationClasses | DescribeGatewayModificationClasses | Queries the instance types to which a gateway can be upgraded. |
| DescribeRegions | DescribeRegions | You can call the DescribeRegions operation to query the valid regions for gateways. |
| DescribeTasks | DescribeTasks | Queries task information, including task progress and name. |
| ListAlertEvents | ListAlertEvents | Lists alert events for a gateway. |
| ListTagResources | ListTagResources | Lists the tags attached to one or more gateways. |
| ModifyGatewayClass | ModifyGatewayClass | Upgrades the gateway class of an online gateway. |
| RestartFileShares | RestartFileShares | Restarts file shares on a Cloud Storage Gateway. |
| TagResources | TagResources | Creates tags and attaches the tags to resources. |
| UntagResources | UntagResources | Detaches tags from a specified gateway. |
| UpgradeGateway | UpgradeGateway | Updates a gateway. |
| UploadGatewayLog | UploadGatewayLog | Uploads gateway diagnostic information. |