API概览

本产品(sgw/2018-05-11)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

网关集群

API

标题

API概述

CreateStorageBundle 创建网关集群 创建网关集群。
ModifyStorageBundle 修改网关集群基本信息 对指定网关集群的基本信息进行修改,包括网关集群名称、描述。
DescribeStorageBundle 查询网关集群信息 查询网关集群信息。包括所在地域、时间戳、名称和描述等。
DeleteStorageBundle 删除指定的网关集群 如果网关集群存在线上或线下云存储网关,请删除所有网关以后再删除该网关集群。
DescribeStorageBundles 查询集群列表信息 查询集群列表信息。包括网关集群名称、描述及创建时间等。

网关

API

标题

API概述

OpenSgwService 开通云存储网关服务 开通网关服务。只有开通服务后,才能进行产品使用。
CreateGateway 创建网关 创建一个包年包月或按量付费的网关。
UpgradeGateway 升级网关 根据网关ID对指定的网关进行升级。
DeleteGateway 删除网关 从所属集群上删除一个按量付费的网关。
DescribeGateway 查询网关基本信息 根据指定网关ID查询网关的基本信息。包括网关状态、类型等详情。
ModifyGateway 修改网关基本信息 对指定网关的基本信息进行修改。包括网关的名称和描述。
DeployGateway 部署一个按量付费的网关 调用DeployGateway接口可以部署一个按量付费的网关。
DescribeTasks 查询任务信息 查询指定任务对应的信息。包括任务的进度和任务名称等。
DescribeGateways 查询网关列表信息 查询网关列表信息。包括网关ID,网关名称等。
DescribeGatewayCategories 查询网关类别 查询网关类别。
DescribeGatewayTypes 查询网关可用类型 根据网关位置,查询网关可用类型。
DescribeAccountConfig 查询账号的配置信息 查询账号配置信息。
DescribeGatewayImages 查询线下网关镜像信息 查询线下网关镜像信息。包括线下网关镜像的名称、描述等。
TriggerGatewayRemoteSync 触发网关反向同步指定路径 主动触发文件网关对指定路径进行一次反向同步。
DescribeRegions 查看可选的地域和可用区 调用DescribeRegions可以查询网关有效的地域信息。
DescribeGatewayClasses 查询网关的所有可用规格 调用DescribeGatewayClasses可查询网关的所有可用规格。
ExpandGatewayNetworkBandwidth 扩容网关数据公网带宽 扩容网关数据公网带宽。

块卷

API

标题

API概述

CreateGatewayBlockVolume 创建块卷 在块网关下创建一个块卷(iSCSI)。
DescribeGatewayBlockVolumes 查询块卷 查询块网关卷详情,例如:操作状态、传输数据、地址、容量、端口、CHAP、OSS Bucket SSL、LUN ID、卷状态。
UpdateGatewayBlockVolume 更新块卷 在块网关下更新块卷配置。
DeleteGatewayBlockVolumes 删除块卷 删除指定的块网关块卷。

文件共享

API

标题

API概述

CreateGatewayFileShare 创建文件共享 在文件网关下创建文件共享。
DescribeGatewayFileStatus 查询文件共享下文件的状态 查询文件网关某个共享下单个文件的状态。
DescribeGatewayFileShares 获取文件网关上共享的配置信息 获取文件网关上共享的配置信息。
UpdateGatewayFileShare 更新文件共享配置 在文件网关下更新文件共享配置。
DeleteGatewayFileShares 删除文件共享 删除指定文件网关中的指定文件共享。
DescribeGatewayNFSClients 查询NFS挂载客户端列表 查询文件网关中NFS挂载客户端列表。
ModifyGatewayFileShareWatermark 调整网关文件共享淘汰水位 调整网关文件共享淘汰水位。
ExpandGatewayFileShare 线下网关扩容文件共享 线下网关扩容文件共享。
CreateGatewaySMBUser 添加SMB用户 在文件网关添加一个SMB用户。
DeleteGatewaySMBUser 删除SMB用户 删除文件网关中指定的SMB用户。
DescribeGatewaySMBUsers 获取SMB用户名列表 获取文件网关上SMB用户名列表。
SetGatewayDNS 添加DNS服务器信息 向文件网关添加NDS服务器信息。
DescribeGatewayDNS 获取网关上配置的DNS服务器信息 调用DescribeGatewayDNS获取网关上配置的DNS服务器信息。
SetGatewayADInfo 添加或清除AD服务器信息 为网关设置或清除AD服务器信息。
DescribeGatewayADInfo 获取网关上配置的AD服务器信息 获取网关上配置的AD服务器信息。

缓存盘

API

标题

API概述

CreateGatewayCacheDisk 创建缓存盘 在网关下创建一个缓存盘。
DescribeGatewayCaches 查询缓存盘 查询缓存盘信息,包括缓存盘大小、类型等。
ExpandCacheDisk 扩容缓存盘 扩容云上网关缓存盘。
DeleteGatewayCacheDisk 删除缓存盘 在文件网关下删除缓存盘。

标签

API

标题

API概述

TagResources 创建并绑定标签 为指定的网关创建并绑定标签。
ListTagResources 查询一个或多个网关已经绑定的标签列表 查询一个或多个网关已经绑定的标签列表。
UntagResources 解绑标签 为指定的网关解绑标签。

日志监控

API

标题

API概述

CreateGatewayLogging 创建网关日志监控 创建网关日志监控。
DescribeGatewayLogging 查询网关日志监控 查询网关日志监控,包括日志监控的状态及日志项目(Project)名称和日志库(Logstore)。
EnableGatewayLogging 启用网关日志监控 启用网关日志监控。
DisableGatewayLogging 禁用网关日志监控 禁用网关日志监控。
DeleteGatewayLogging 删除网关日志监控 删除网关日志监控。

极速同步组

API

标题

API概述

CreateExpressSync 创建极速同步组 创建极速同步组。
AddSharesToExpressSync 添加共享到极速同步组中 添加共享到极速同步组中,可以添加多个共享。
DescribeExpressSyncs 查询极速同步组 查询极速同步组,包括极速同步组名称、极速同步组ID、Bucket名称等详情。
DescribeExpressSyncShares 查询极速同步组的共享信息或可加入的共享信息 查询极速同步组对应的共享信息或可加入极速同步组的共享信息。包括极速同步组对应共享的网关名称、集群ID、共享名称等详情。
DeleteExpressSync 删除极速同步组 删除指定极速同步组。
RemoveSharesFromExpressSync 删除极速同步组对应的共享 调用RemoveSharesFromExpressSync可以删除极速同步组对应的共享。可删除多个共享。