API概览

本产品(实时数仓 Hologres/2022-06-01)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
CreateInstance创建实例该接口用于创建Hologres实例。
DeleteInstance删除实例该接口用于释放Hologres实例。
RenewInstance实例续费该接口用于为Hologres实例手动续费。可以在续费的同时开启按月自动续费。
RestartInstance重启实例重启实例。
ResumeInstance恢复实例恢复暂停的实例。
UpdateInstanceName修改实例名称修改实例名称。
UpdateInstanceNetworkType切换实例的网络类型修改实例网络。
DisableHiveAccess关闭数据湖加速关闭数据湖加速。
EnableHiveAccess开启数据湖加速开启数据湖加速。
StopInstance停止实例暂停实例。
ScaleInstance实例变配该接口用于变更Hologres实例的规格和存储空间。
ChangeResourceGroup更新资源组更新资源组。
ListInstances获取实例列表获取实例列表。
GetInstance获取实例详情获取实例详情。

计算组

API标题API概述
CreateHoloWarehouse创建计算组创建计算组。
DeleteHoloWarehouse删除计算组删除计算组。
RebalanceHoloWarehouse计算组均衡分片计算组均衡分片。
ResumeHoloWarehouse恢复计算组从停机状态恢复到正常状态。
SuspendHoloWarehouse停止计算组停止计算组。
RenameHoloWarehouse重命名计算组重命名计算组。
ScaleHoloWarehouse变配计算组计算组扩缩容。
RestartHoloWarehouse重启计算组重启计算组。
GetWarehouseDetail计算组详情计算组详细信息。
ListWarehouses计算组列表计算组列表

备份

API标题API概述
ListBackupData查询备份列表查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照,可以通过新购实例完全恢复原来的数据。