阿里云OpenAPI开发者门户

云数据库 HBase - OpenAPI 概览2019-01-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
服务地域
OpenAPI 名称描述操作
DescribeRegionshot查询可用地域查看文档去调试
多可用区集群
OpenAPI 名称描述操作
CreateMultiZoneCluster可以创建多可用区集群查看文档去调试
DescribeMultiZoneAvailableRegionshot多可用区的可用地域组合查看文档去调试
DescribeMultiZoneCluster可以获取多可用区实例的详情信息查看文档去调试
ResizeMultiZoneClusterDiskSize修改多可用区实例的磁盘大小查看文档去调试
ResizeMultiZoneClusterNodeCount对多可用区实例进行扩节点查看文档去调试
UpgradeMultiZoneCluster通过UpgradeMultiZoneCluster接口可以对多可用区实例进行组件的小版本升级查看文档去调试
DeleteMultiZoneCluster通过DeleteMultiZoneCluster接口删除多可用区实例查看文档去调试
EvaluateMultiZoneResource评估是否存在可用资源查看文档去调试
集群
OpenAPI 名称描述操作
DescribeDeletedInstances获取已删除但未完全释放的集群列表查看文档去调试
DescribeIpWhitelisthot根据集群id获取集群白名单信息列表查看文档去调试
实例
OpenAPI 名称描述操作
CreateClusterhot创建HBase集群查看文档去调试
AddUserHdfsInfo在Xpack里增加用户自建的hdfs地址查看文档去调试
DescribeInstancehot查询HBase实例的详细信息查看文档去调试
DescribeInstanceshot查询指定地域的HBase实例列表信息查看文档去调试
DescribeInstanceTypehot查询实例规格(cpu、mem)查看文档去调试
DescribeClusterConnectionhot查询集群连接列表查看文档去调试
DescribeAvailableResourcehot查询可用资源查看文档去调试
DescribeSubDomain获取一个可用子域查看文档去调试
QueryXpackRelateDB查询当前实例可关联的数据库列表查看文档去调试
DescribeDiskWarningLine目前仅支持HBase和HBaseue查看文档去调试
ModifyInstanceMaintainTime修改实例运维起始时间查看文档去调试
ModifyInstanceType更改实例的规格查看文档去调试
EnableHBaseueModule开通扩展服务查看文档去调试
ModifyInstanceName修改实例名称查看文档去调试
ModifyDiskWarningLine对于HBase集群版和HBaseue集群可通过ModifyDiskWarningLine接口更改磁盘容量告警线,默认告警线为80%查看文档去调试
ModifyUIAccountPassword调用ModifyUIProxyAccountPassword重置集群管理UI访问密码查看文档去调试
DeleteInstance释放HBase实例查看文档去调试
DeleteHBaseHaDB删除已创建的Ha实例查看文档去调试
DeleteUserHdfsInfo删除Xpack里用户自建的hdfs信息查看文档去调试
ResizeNodeCount调整整个实例节点数查看文档去调试
ResizeColdStorageSize更改冷存储大小查看文档去调试
RestartInstance重启HBase集群查看文档去调试
MoveResourceGroup将目标实例移动至目标资源组查看文档去调试
PurgeInstance针对已删除(未超过7天)但未完全清理的实例查看文档去调试
RenewInstance为HBase实例续费查看文档去调试
ResizeDiskSize调整磁盘大小查看文档去调试
UpgradeMinorVersion集群通过UpgradeMinorVersion进行小版本升级查看文档去调试
XpackRelateDB关联数据库查看文档去调试
ConvertInstance将实例从按量收费转为包年包月收费查看文档去调试
安全
OpenAPI 名称描述操作
DescribeSecurityGroups根据集群ID获取集群所属安全组信息查看文档去调试
ModifyIpWhitelist修改实例的分组白名单查看文档去调试
ModifySecurityGroups修改集群所属安全组查看文档去调试
备份
OpenAPI 名称描述操作
CreateBackupPlan目前仅支持HBaseue查看文档去调试
DescribeBackupPlanConfig查询备份计划配置查看文档去调试
DescribeBackupPolicy通过DescribeBackupPolicy获取hbase集群的备份规则查看文档去调试
DescribeBackups通过DescribeBackups获取hbase集群备份记录信息查看文档去调试
DescribeBackupStatus描述备份任务状态查看文档去调试
DescribeBackupSummaryHBaseue备份开启后,通过DescribeBackupSummary接口获取备份详情查看文档去调试
DescribeBackupTables通过调用DescribeBackupTables接口获取某一次备份记录的备份表的信息查看文档去调试
DescribeRecoverableTimeRangeHBaseue备份开启后,可通过DescribeRecoverableTimeRange接口获取可恢复的时间范围查看文档去调试
EnableHBaseueBackup开通HBaseue备份恢复查看文档去调试
ModifyBackupPlanConfig对于已开通备份恢复的HBaseue集群查看文档去调试
ModifyBackupPolicy更改HBase集群的备份计划查看文档去调试
CloseBackup通过CloseBackup关闭hbase集群的备份恢复功能查看文档去调试
OpenBackup通过OpenBackup打开hbase集群的备份恢复功能查看文档去调试
恢复
OpenAPI 名称描述操作
CreateRestorePlan对于已开通备份恢复集群,可将已备份的数据恢复到当前region的其他同款HBaseue集群里查看文档去调试
DescribeRestoreFullDetails对于已开启备份恢复的HBaseue集群,通过DescribeRestoreFullDetails接口查询具体某个全量恢复的详情查看文档去调试
DescribeRestoreIncrDetail通过DescribeRestoreIncrDetail接口获取增量恢复详情查看文档去调试
DescribeRestoreSchemaDetails对于已开启备份恢复的HBaseue集群,通过DescribeRestoreSchemaDetails接口查询具体恢复Schema的详情查看文档去调试
DescribeRestoreSummary对于已开通备份恢复的HBaseue集群,通过DescribeRestoreSummary接口获取数据恢复概要查看文档去调试
DescribeRestoreTables对于已经发起过备份后恢复的集群,可通过DescribeRestoreTables获取对应恢复记录的详情查看文档去调试
网络
OpenAPI 名称描述操作
AllocatePublicNetworkAddress申请公网地址查看文档去调试
DescribeEndpointshot查询HBase实例的数据库连接信息查看文档去调试
ReleasePublicNetworkAddress释放公网地址查看文档去调试
用户
OpenAPI 名称描述操作
CreateAccount创建宽表账号查看文档去调试
DescribeAccounts查询数据库账号列表查看文档去调试
ModifyAccountPassword修改数据库访问账号密码查看文档去调试
Grant授权账号权限查看文档去调试
Revoke回收宽表账号权限查看文档去调试
DeleteAccount删除宽表数据库账号查看文档去调试
标签
OpenAPI 名称描述操作
ListTagResources通过ResourceId或者Tag(Key查询、key和value同时查询)获取标签列表查看文档去调试
ListTags根据region获取该region下所有Tag查看文档去调试
TagResources实例增加Tag标签查看文档去调试
UnTagResources对照TagResources查看文档去调试
Serverless集群
OpenAPI 名称描述操作
CreateServerlessCluster新建HBase Serverless集群查看文档去调试
DescribeServerlessCluster查询Serverless集群详情查看文档去调试
DeleteServerlessCluster删除HBase Serverless集群查看文档去调试
Ha负载均衡
OpenAPI 名称描述操作
CreateHbaseHaSlbBDS集群创建高可用HBase后,此接口可用于创建对应的高可用thrift或高可用phoenix查看文档去调试
SwitchHbaseHaSlb对照CreateHbaseHaSlb接口,此接口用于高可用thrift或高可用phoenix的主备切换查看文档去调试
DeleteHbaseHaSlb对照CreateHbaseHaSlb接口,此接口用于删除对应的高可用thrift或高可用phoenix查看文档去调试
全局资源
OpenAPI 名称描述操作
CreateGlobalResource通过CreateGlobalResource创建集群里的全局资源查看文档去调试
DeleteGlobalResource通过DeleteGlobalResource删除该集群的全局资源查看文档去调试
其他
OpenAPI 名称描述操作
DescribeDBInstanceUsage根据集群id获取HBase集群运行水位状态查看文档去调试
DescribeMultiZoneAvailableResource通过DescribeMultiZoneAvailableResource获取多可用区可购买的资源查看文档去调试
ModifyClusterDeletionProtection通过ModifyClusterDeletionProtection设置实例的是否删除保护属性查看文档去调试
ModifyMultiZoneClusterNodeType通过ModifyMultiZoneClusterNodeType修改多可用区实例的节点规格查看文档去调试
QueryHBaseHaDBBDS集群查询高可用HBase列表。对照CreateHaCluster与CreateHbaseHaSlb。该接口会返回对应的高可用列表查看文档去调试
CheckComponentsVersion检查组件的版本是否为最新版本查看文档去调试
CreateHBaseSlbServer通过CreateHBaseSlbServer创建负载均衡服务查看文档去调试
DeleteHBaseSlbServer删除已开通的负载均衡服务查看文档去调试
DescribeColdStorage获取实例的冷存储信息查看文档去调试
GetMultimodeCmsUrl根据集群id获取监控地址查看文档去调试
ListHBaseInstances获取同一个vpc下的HBase实例查看文档去调试
ListInstanceServiceConfigHistories通过ListInstanceServiceConfigHistories获取集群参数的修改历史查看文档去调试
ListInstanceServiceConfigurations通过ListInstanceServiceConfigurations获取集群配置项信息查看文档去调试
ModifyInstanceServiceConfig更改集群配置,可修改的配置项可通过ListInstanceServiceConfigurations接口查看查看文档去调试
RelateDbForHBaseHa调用此接口在BDS集群中增加添加主备双活实例查看文档去调试
CancelActiveOperationTasks取消运维事件任务查看文档去调试
DescribeActiveOperationTaskType查询HBase实例的运维任务类型,各类型的任务数量和详请查看文档去调试
ModifyActiveOperationTasks修改运维任务的计划切换时间查看文档去调试
DescribeActiveOperationTasks查询HBase实例的运维任务详情查看文档去调试
SwitchService开通或关闭扩展服务查看文档去调试
2024年08月20日