API标准及多语言预置SDK
本产品（Hologram/2022-06-01）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
升级
|
API |
标题 |
API概述 |
| GetUpgradeable | 查询是否可升级 | 查询是否可升级 |
| GetUpgradeStatus | 查询升级状态 | 查询升级状态 |
| GetLastUpgradeRecord | 查询升级记录 | 获取上次升级历史 |
| ListUpgradeReleaseVersions | 可升级版本列表 | 获取可升级版本列表 |
| UpdateAutoUpgrade | 开启小版本自动升级 | 开启小版本自动升级。开启后，将在运维时间窗口自动升级实例 |
| UpgradeInstance | 升级实例 | 升级实例。如果Prepare成功，则实例可以直接开始升级。 |
| UpdateOperationEventScheduleTime | 更新运维事件执行时间 | 修改运维事件执行时间 |
| UpdateMaintenanceWindow | 设置可维护时间窗口 | 用于设定实例的可维护时间段，以便进行系统维护。 |
| PrepareUpgrade | 升级准备 | 启动升级前的准备。升级前需要做一轮评估，评估通过，则可以升级，否则需要联系人工升级。 |
| DiscardUpgrade | 取消升级 | 取消升级.请求条件：只在还未开始或者处于pre_check状态的任务按钮不置灰，显示为取消升级。一旦进入backup状态或者之后的状态，就不允许取消了。 |
标签
|
API |
标题 |
API概述 |
| UntagResources | 删除实例标签 | 删除实例标签 |
| TagResources | 新增实例标签 | 新增tag |
| DescribeTags | 列出所有标签 | 列出所有标签 |
执行SQL
|
API |
标题 |
API概述 |
| GetExecuteStatementEnabled | 查询实例是否开启ExecuteStatement功能 | 检查指定Hologres实例是否已开启通过OpenAPI执行SQL的功能。 |
| ExecuteStatement | 执行SQL语句 | 通过OpenAPI在指定数据库上同步执行SQL语句并返回结果。 |
| EnableExecuteStatement | 开启实例SQL执行API | 为指定Hologres实例启用通过OpenAPI执行SQL的功能。 |
| DisableExecuteStatement | 禁用实例的ExecuteStatement功能 | 关闭指定Hologres实例的ExecuteStatement API访问权限 |
大模型
|
API |
标题 |
API概述 |
| ListInstanceModel | AI节点资源列表 | AI节点资源列表 |
| UpdateModelService | 更新模型服务 | 创建模型服务，只适用于Hologres AI |
| ListModelCatalog | 模型列表 | 模型列表 |
| CreateModelService | 创建模型服务 | 创建模型服务，支持AI function调用模型。支持创建两类模型：1）阿里云百炼模型；2）Hologres AI节点。如果是Hologres AI，需要另外购买AI节点资源。 |
| DeleteModelResource | 删除节点资源 | 删除节点资源，节点部署的所有模型将被删除，不可恢复。 |
| DeleteModelService | 删除模型服务 | 删除模型服务 |
| GetInstanceModel | 实例部署模型详情 | Holo实例已经绑定的大模型服务列表 |
数据库
|
API |
标题 |
API概述 |
| CreateDatabase | 创建数据库 | 创建db |
| CreateExternalDatabase | 创建外部数据库 | 创建外部db |
| CreateUser | 创建用户 | 将Ram子账号/STS账号添加到Hologres实例，作为实例账号使用，添加后，即可以Ram/STS身份登陆实例。 |
| DropUser | 删除用户 | 将Ram子账号/STS账号从Hologres帐户体系删除，删除后，Ram/STS不能再登陆实例。如需登陆实例，请用CreateUser重新添加。 |
| RevokeTablePermission | 撤销表授权 | 取消表授权。 |
| RevokeSchemaPermission | 撤销Schema授权 | 取消Schema授权。 |
| RevokeDatabasePermission | 撤销数据库授权 | 取消DB授权。 |
| ListDatabases | 数据库列表 | 获取DB列表。 |
| GrantTablePermission | 表授权 | DB授权。 |
| GrantSchemaPermission | Schema授权 | DB授权。 |
| GrantDatabasePermission | 数据库授权 | DB授权。 |
实例
|
API |
标题 |
API概述 |
| BindLeaderInstance | 绑定从实例 | 绑定从实例 |
| ListLeaderInstances | 获取主实例列表 | 获取可能的主实例Id列表。 |
| ListFollowerInstances | 从实例列表 | 获取只读从实例 |
| UnBindLeaderInstance | 解绑主从实例 | 解除绑定主实例 |
| CreateInstance | 创建实例 | 该接口用于创建实例。 |
| DeleteInstance | 删除实例 | 该接口用于释放实例。 |
| RenewInstance | 实例续费 | 该接口用于为实例手动续费。可以在续费的同时开启按月自动续费。 |
| RestartInstance | 重启实例 | 该接口用于重启Hologres实例。 |
| ResumeInstance | 恢复实例 | 恢复暂停的实例。 |
| UpdateInstanceName | 修改实例名称 | 该接口用于修改实例名称。 |
| UpdateInstanceNetworkType | 切换实例的网络类型 | 该接口用于修改实例网络类型。 |
| DisableHiveAccess | 关闭数据湖加速 | 该接口用于关闭数据湖加速。 |
| EnableHiveAccess | 开启数据湖加速 | 该接口用于开启数据湖加速。 |
| StopInstance | 停止实例 | 该接口用于暂停实例。 |
| ScaleInstance | 实例变配 | 该接口用于变更实例的规格和存储空间。 |
| ChangeResourceGroup | 更新资源组 | 更新资源组。 |
| ListInstances | 获取实例列表 | 获取实例列表。 |
| GetInstance | 获取实例详情 | 该接口用于获取实例详情。 |
计算组
|
API |
标题 |
API概述 |
| UpdateWarehouseScheduleTask | 更新计算组分时弹性计划 | 更新计算组分时弹性计划 |
| ListWarehouseScheduleTask | 计算组分时弹性计划列表 | 获取指定实例下的所有计算组分时弹性计划任务列表。 |
| ListWarehouseScheduleEvent | 弹性事件列表 | 查询指定实例在给定时间范围内的弹性调度事件。 |
| CreateWarehouse | 创建Warehouse | 创建warehouse |
| CreateHoloWarehouse | 创建计算组 | 创建计算组。 |
| DeleteHoloWarehouse | 删除计算组 | 删除计算组。 |
| RebalanceHoloWarehouse | 计算组均衡分片 | 计算组均衡分片。 |
| ResumeHoloWarehouse | 恢复计算组 | 从停机状态恢复到正常状态。 |
| SuspendHoloWarehouse | 停止计算组 | 停止计算组。 |
| RenameHoloWarehouse | 重命名计算组 | 重命名计算组。 |
| ScaleHoloWarehouse | 变配计算组 | 计算组扩缩容。 |
| RestartHoloWarehouse | 重启计算组 | 重启计算组。 |
| GetWarehouseDetail | 计算组详情 | 计算组的详细信息。 |
| CreateWarehouseScheduleTask | 创建分时弹性计划 | 创建分时弹性计划 |
| ListWarehouses | 计算组列表 | 获取计算组列表。 |
| DisableWarehouseAutoScale | 关闭自动弹性 | 关闭自动弹性 |
| DeleteWarehouseScheduleTask | 删除计算组弹性计划 | 删除计算组弹性计划 |
| EnableWarehouseAutoScale | 开启自动弹性 | 开启自动弹性 |
备份
|
API |
标题 |
API概述 |
| UpdateScheduledBackupConfig | 配置备份策略 | 配置备份策略。以周为周期，可以指定一周内的数个固定日期启动实例备份，比如周一、周三、周五的20:00:00。已完成的备份，可以配置保留个数，过期的备份会被自动清理。 |
| UpdateBackupDataDesc | 修改备份描述 | 更新备份描述 |
| CreateManualBackup | 创建实例备份 | 创建实例备份。 |
| ListBackupData | 查询备份列表 | 该接口用于查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照，可以通过新购实例完全恢复原来的数据。 |
| DeleteBackupData | 删除实例备份 | 删除备份 |
| GetScheduledBackupConfig | 获取备份配置 | 获取备份配置。 |
安全
|
API |
标题 |
API概述 |
| UpdateInstancePort | 修改实例端口号 | 修改端口号 |
| UpdateHoloWebLoginSetting | 修改holoweb登陆权限 | 修改holoweb登陆权限 |
| GetHoloWebLoginSetting | 查询HoloWeb登录权限 | 获取holoweb登陆权限 |
| DisableSupportAccount | 关闭服务账号 | 关闭服务账号 |
| EnableSupportAccount | 开启服务账号 | 打开服务账号 |
| EnableSSL | 开启SSL | 打开SSL |
| DisableSSL | 关闭SSL | 关闭SSL。 |
| GetCertificateAttribute | 查看实例证书属性 | 获得证书信息。 |
| GetRootCertificate | 下载证书 | 获取根证书。 |
| RenewSSLCertificate | 更新证书 | 更新SSL证书。 |
其他
|
API |
标题 |
API概述 |
| DisableOperationEvent | 关闭运维日志 | 关闭运维日志 |
| ListMigrationZones | 查询可迁移可用区 | 查询可以迁移可用区。3AZ实例，可以在可用区之间自助迁移。 |
| ListOperationEvents | 查询操作事件列表 | 获取指定条件下的操作事件列表，支持分页和排序。 |
| ListRegions | 地域列表 | Hologres所有地域列表 |
| MigrateInstanceZone | 迁移实例 | 迁移实例到目标可用区。仅3AZ实例支持，无需迁移存储，直接在目标可用区启动实例，大约5分钟。 |
该文章对您有帮助吗？