API概览

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

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

服务地域

API

标题

API概述

DescribeRegions 查询地域信息 查询块存储EBS相关功能异步复制、数据洞察、专属块存储集群支持的地域信息。

复制对

API

标题

API概述

CreateDiskReplicaPair 创建云盘异步复制关系 创建一个云盘异步复制关系。
AddDiskReplicaPair 添加复制对到一致性复制组 调用AddDiskReplicaPair接口,并可以指定ReplicaGroupId、ReplicaPairId、ClientToken等参数,添加复制对到一致性复制组,最终通过一致性复制组,您可以批量管理复制对。
ModifyDiskReplicaPair 修改云盘异步复制关系 修改一个云盘异步复制关系。
StartDiskReplicaPair 开始云盘异步复制 为指定的异步复制关系激活异步复制功能。
StopDiskReplicaPair 停止云盘异步复制 为指定的异步复制关系停止异步复制功能。
ReprotectDiskReplicaPair 启用云盘反向异步复制 启用异步复制关系的反向复制功能。
FailoverDiskReplicaPair 启用云盘异步复制故障切换 启用异步复制关系的故障切换功能。
DescribeDiskReplicaPairProgress 查询复制对的同步进度 查询复制对的同步进度。
DeleteDiskReplicaPair 删除云盘异步复制关系 删除一个异步复制关系。
DescribeDiskReplicaPairs 查询一个或多个异步复制关系 查询指定地域下,一个或多个异步复制关系的信息。
RemoveDiskReplicaPair 移除一致性复制组中的复制对 移除一致性复制组中的复制对。移除复制对只是解除了复制对和一致性复制组的绑定关系,不会删除复制对。
DescribePairDrills 查询复制对当前的容灾演练 该接口用于查询当前地域的盘作为复制对从端时,曾经对复制对所启动的容灾演练。
StartPairDrill 对异步复制对的从盘启动容灾演练 您可以通过演练切换功能确保复制流程持续运行,同时将从盘最近恢复点的数据克隆至一块新的云盘,定期验证容灾站点应用的完整性和正确性。
ClearPairDrill 清理异步复制对的容灾演练 该接口可以清理之前复制对从盘启动的容灾演练,并尝试删除自动创建出来的演练盘。

复制组

API

标题

API概述

CreateDiskReplicaGroup 创建异步复制组 创建一个一致性复制组。
DescribeDiskReplicaGroups 查询一个或多个异步复制组 查询在指定地域下,一个或多个一致性复制组的信息。
ModifyDiskReplicaGroup 修改异步复制组 修改一致性复制组的名称、描述信息或者RPO。
StartDiskReplicaGroup 开始异步复制组 启动一致性复制组中复制对的异步复制功能。首次同步时,系统会先进行一次全量同步,之后会按照保证RPO(Recovery Point Object)的时间周期内进行增量同步。
StopDiskReplicaGroup 停止异步复制组 停止一致性复制组中复制对的异步复制功能。
FailoverDiskReplicaGroup 启用异步复制组故障切换 启用一致性复制组中复制对的故障切换功能。当一致性复制组中某些复制对的主盘出现故障时,可以调用该接口恢复从盘的读写权限。
ReprotectDiskReplicaGroup 启用异步复制组反向复制 启用一致性复制组中复制对的反向复制功能。启用反向复制功能后,可以将原灾备站点的云盘数据复制到原生产站点的云盘当中。反向复制数据时,一致性复制组中原有的站点信息不变,主从关系颠倒。
DeleteDiskReplicaGroup 删除异步复制组 删除一致性复制组。
DescribeReplicaGroupDrills 查询复制组当前的容灾演练 该接口用于查询当前地域的盘作为复制组从端时,曾经对复制组所启动的容灾演练。
StartReplicaGroupDrill 对异步复制组的从盘启动容灾演练 您可以通过演练切换功能确保复制流程持续运行,同时将从盘最近恢复点的数据克隆至一块新的云盘,定期验证容灾站点应用的完整性和正确性。
ClearReplicaGroupDrill 清理异步复制组的容灾演练 该接口可以清理之前复制组从盘启动的容灾演练,并尝试删除自动创建出来的演练盘。

专属块存储集群

API

标题

API概述

CreateDedicatedBlockStorageCluster 创建专属块存储集群 调用CreateDedicatedBlockStorageCluster接口,并指定Azone、Capacity、Type、PeriodUnit等参数,创建专属块存储集群。
DescribeDedicatedBlockStorageClusters 查询专属块存储集群 查询专属集群OpenApi
ModifyDedicatedBlockStorageClusterAttribute 修改专属块存储集群属性 修改专属块存储集群的信息。
DescribeDedicatedBlockStorageClusterDisks 查询专属块存储集群中的云盘列表 查询一块或多块您已经创建的专属块存储集群的云盘信息。
QueryDedicatedBlockStorageClusterInventoryData 查询专属块存储集群创盘容量趋势数据 调用QueryDedicatedBlockStorageClusterInventoryData查询指定时间范围下,专属块存储集群容量趋势数据,包括可用容量和总容量。

企业级快照策略

API

标题

API概述

CreateEnterpriseSnapshotPolicy 创建企业级快照策略 调用CreateEnterpriseSnapshotPolicy创建企业级快照策略。
DescribeEnterpriseSnapshotPolicy 查找企业级快照策略 调用DescribeEnterpriseSnapshotPolicy接口,并可以指定PolicyIds、ResourceGroupId、Tag等参数,查找企业级快照策略。
UpdateEnterpriseSnapshotPolicy 修改企业级快照策略 调用UpdateEnterpriseSnapshotPolicy修改企业级快照策略配置。
BindEnterpriseSnapshotPolicy 绑定企业级快照策略 调用BindEnterpriseSnapshotPolicy绑定云盘到企业级快照策略。
UnbindEnterpriseSnapshotPolicy 解除企业级快照策略绑定 调用UnbindEnterpriseSnapshotPolicy为云盘解除企业级快照策略绑定。
DeleteEnterpriseSnapshotPolicy 删除企业级快照策略 调用DeleteEnterpriseSnapshotPolicy删除企业级快照策略。

数据洞察

API

标题

API概述

ApplyLensService 开通数据洞察服务 开通块存储数据洞察(CloudLens for EBS)。
DescribeLensServiceStatus 查询数据洞察服务状态 查询用户开通ebs数据洞察服务状态。
CancelLensService 取消数据洞察服务 取消块存储数据洞察(CloudLens for EBS)。
DescribeLensMonitorDisks 查询一块或多块您已经创建的块存储云盘 查询一块或多块您已经创建的块存储云盘。
DescribeEvents 查询资源事件 查询云盘风险事件。
DescribeMetricData 查询监控指标 查询资源监控指标。
DescribeDiskMonitorDataList 查询云盘监控列表(API下线中) 查询多个云盘的秒级监控数据。当前仅支持查询多个AutoPL云盘Burst数据,数据以小时聚合。
DescribeDiskMonitorData 查询云盘监控(API下线中) 查询单个云盘的秒级监控数据。
DescribeDiskEvents 查询云盘事件(API下线中) 查询云盘风险事件。API正在下线中,请切换至新API:DescribeEvents。

实验室

API

标题

API概述

UpdateSolutionInstanceAttribute 更新解决方案实例属性 更新解决方案实例属性。

其他

API

标题

API概述

TagResources 绑定资源标签 为指定的EBS资源统一绑定标签。
ListTagResources 查询资源标签 查询一个或多个EBS资源已经绑定的标签信息,或查询指定的非默认资源组内的资源ID及标签信息。
UntagResources 解绑资源标签 为指定的EBS资源统一解绑标签。
ChangeResourceGroup 修改资源组 修改EBS资源所在资源组。
DescribeSolutionInstanceConfiguration 查询解决方案默认配置 查询解决方案默认配置。
QueryDedicatedBlockStorageClusterDiskThroughputStatus 查询设置专属块存储集群云盘吞吐状态 查询通过SetDedicatedBlockStorageClusterDiskThroughput API设置的专用块存储集群磁盘的吞吐量状态。
SetDedicatedBlockStorageClusterDiskThroughput 设置专属块存储集群AutoPL云盘吞吐上限 弹性型专属存储集群内,方便您实现指定云盘目标的bps值的功能;只需要设置云盘ID和目标吞吐,简化您设置性能控制、修改预配置、调节云盘burst的步骤。
ListReports 查询用户使用报告列表 中心化角色:查询指定应用历史报告列表
GetReport 获取用户云盘使用报告 中心化角色:使用reportId获取用户使用报告
DescribeUserTagKeys 查询用户标签键 中心化角色:查询用户云盘快照tagKeys
DescribeUserTagValues 查询用户标签内容 中心化角色:查询用户云盘快照tagValues

其他

API

标题

API概述

ListReplicaEdgeSupported 查询可用区支持的异步复制目的地域和可用区 查询某个可用区支持的异步复制目的地域和可用区。