本产品（starrocks/2022-10-19）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
网关管理
|
API |
标题 |
API概述 |
| UpdateGateway | 更新节点数量 | 更新网关节点数量 |
| ListGateway | 网关列表 | 获取网关列表 |
| DeleteGateway | 删除网关 | 删除网关 |
| AddGateway | 新增网关 | 新建网关 |
实例管理
|
API |
标题 |
API概述 |
| CreateInstanceV1 | 创建实例 | 本接口用于创建 Serverless StarRocks 实例。 |
| RestartInstance | 重启实例 | 本接口用于重启 Serverless StarRocks 实例。 |
| ReleaseInstance | 释放实例 | 本接口仅用于释放 Serverless StarRocks 按量付费实例。包年包月实例请到用户中心退订管理页进行退订。 |
| UpdateInstanceName | 修改实例名称 | 本接口用于修改 Serverless StarRocks 实例名称。 |
| DescribeInstances | 查询实例 | 本接口用于查询Serverless StarRocks 实例，支持根据实例名称或标签等信息进行过滤。 |
| DescribeNodeGroups | 查询计算组 | 获取节点组信息 |
| TagResources | 绑定标签 | 为指定资源绑定标签。 |
| UnTagResources | 解绑标签 | 为指定的资源列表统一解绑标签。 |
| ChangeResourceGroup | 修改资源组 | 本接口用于修改 Serverless StarRocks 实例的资源组。 |
版本管理
|
API |
标题 |
API概述 |
| UpgradeVersion | 升级版本 | 本接口用于升级 Serverless StarRocks 实例版本。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于升级小版本，也可以用于升级主版本。 可以使用接口 QueryUpgradableVersions 查询集群的可升级版本。 |
| QueryUpgradableVersions | 查询可升级的版本列表 | 本接口用于查询 Serverless StarRocks 实例可升级的版本列表。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于查询可升级的小版本，也可以用于查询可升级的主版本。 |
资源变配
|
API |
标题 |
API概述 |
| ModifyNodeNumberPreCheck | 计算组节点数量修改前的预检查 | 本接口用于对修改 Serverless StarRocks 实例的计算组中节点数量的操作进行预检查。 |
| ModifyNodeNumber | 修改节点数量 | 本接口用于修改 Serverless StarRocks 实例计算组的节点数量。 |
| ModifyCuPreCheck | 计算组节点CU修改前的预检查 | 本接口用于对修改 Serverless StarRocks 实例的 FE、BE、CN 计算组中节点 CU 数量的操作进行预检查操作，以判断能否执行 CU 的升配或者降配操作。 |
| ModifyDiskPerformanceLevel | 修改磁盘性能级别 | 本接口用于修改 Serverless StarRocks 实例的计算组的节点磁盘性能级别。 |
| ModifyDiskSize | 磁盘扩容 | 本接口用于对 Serverless StarRocks 实例计算组节点进行磁盘扩容。 |
| ModifyDiskNumber | 增加磁盘数量 | 本接口用于增加 Serverless StarRocks 实例计算组的节点磁盘块数。 |
| ModifyCu | 修改CU数量 | 本接口用于修改 Serverless StarRocks 实例计算组节点的 CU 数量。 |
配置管理
|
API |
标题 |
API概述 |
| DescribeInstanceConfigs | 查询实例配置 | 查询实例配置 |
| DescribeConfigHistory | 查询配置修改历史 | 查询实例配置历史 |
| ModifyInstanceConfig | 修改实例配置 | 本接口用于修改 Serverless StarRocks 实例配置。 |
| ModifyInstanceConfigPreCheck | 修改实例配置前的预检查 | 本接口用于对修改 Serverless StarRocks 实例配置操作进行预检查。 |
| RollbackConfigModification | 回滚之前的配置修改 | 回滚正在进行中的配置修改 |
其他
|
API |
标题 |
API概述 |
| CreateServiceLinkedRole | 创建服务角色 | 该接口用于为用户创建 AliyunServiceRoleForEMRStarRocks 角色。 |
| DeleteBackup | 删除数据备份 | 删除数据备份 |
| DeleteInnerIpWhitelistGroup | 删除内网白名单分组 | 删除内网白名单分组 |
| DescribeRegions | 查看可用地域 | 查看可用地域列表。 |
| DescribeSystemTimezone | 获取实例的系统时区 | 获取 starrocks 实例的系统时区 |
| EnableInternalSlb | 开启内网SLB | 默认网关开启内网SLB |
| IsolateLeader | 开启读写分离 | 是否开启读写分离（Leader FE 节点处理写请求，其余节点处理读请求）。 |
| ModifyUserPassword | 修改 starrocks 用户的密码 | 修改 starrocks 用户的密码 |
| QueryUnpaidOrder | 查询计算组/集群的未支付订单 | 查询计算组/集群的未支付订单 |
| RestartNodeGroup | 重启计算组 | 重启指定的node group |
| RestartNodes | 重启集群节点 | 重启集群中的节点 |
| RestoreInstance | 从备份中恢复实例 | 从备份中恢复实例 |
| ResumeInstance | 恢复已停机实例 | 该接口用于恢复来自openlake自动停机的实例。 |
| SwitchActiveStandbyZones | 切换主备可用区 | 切换主备可用区。 |
| ToggleAutoMinorVersionUpgrade | 开启/关闭小版本自动升级 | 开启/关闭StarRocks实例的小版本自动更新 |
| TogglePublicSlb | 开启公网slb开关 | 公网SLB开关 |
| UpdateBackup | 更新备份任务信息 | 更新备份任务描述 |
| AddBackupPolicy | 新增备份策略 | 新增备份策略 |
| CheckInventory | 校验资源库存 | 校验资源库存 |
| CreateAgentResource | 创建Agent计算组 | 创建Agent计算组 |
| CreateScalingRule | 新建弹性规则 | 新建一条弹性规则 |
| DeleteBackupPolicy | 删除备份策略 | 删除备份策略 |
| DeleteScalingRule | 删除弹性规则 | 删除一条弹性规则 |
| DescribeAvailableZones | 查看地域可用区列表 | 查看地域可用区列表 |
| DescribeBackupPolicies | 获取备份策略详情 | 获取备份策略详情 |
| DescribeBackups | 获取备份详情 | 获取备份详情 |
| DescribeEventNames | 获取集群事件名称 | 获取集群事件名称 |
| DescribeInnerIpWhitelistGroups | 查询内网白名单分组 | 查询内网白名单分组 |
| DescribeInstanceDiagnosisResult | 获取实例的健康诊断结果 | 获取实例的健康诊断结果 |
| DescribeInstanceMetaToken | 获取实例迁移的Meta Token | 获取 StarRocks 实例的 Meta Token。 |
| DescribeResourceConstraints | 获取资源约束配置 | 获取资源约束配置 |
| DescribeTimeTriggerScalingRules | 查询基于时间触发的弹性规则 | 获取时间触发规则信息 |
| DisableSSLConnection | StarRocks连接关闭SSL | StarRocks连接关闭SSL |
| EnableMultiAz | 实例开启多可用区 | 开启Multi AZ |
| EnableSSLConnection | StarRocks连接开启SSL | StarRocks连接开启SSL |
| GetInstanceFeatureGate | StarRocks集群实例的特性开关 | 获取StarRocks集群实例的特性开关 |
| GetNodeGroupFeatureGate | 获取计算组实例的特性开关 | 获取StarRocks 计算组实例的特性开关 |
| ListOperationActivity | 查询操作详情 | 获取操作的详细信息 |
| ListOperationHistory | 查询集群操作历史 | 获取集群的操作历史 |
| ModifyChargeType | 修改实例的付费类型 | 修改实例的付费类型 |
| ModifyDiskType | 修改计算组的节点磁盘类型 | 修改计算组的节点磁盘类型 |
| ModifyHostAlias | 修改主机别名 | 修改/etc/hosts |
| ModifyMaintainableTime | 修改实例可维护时间 | 修改Starrocks实例的可维护时间 |
| ModifyScalingRule | 修改弹性伸缩规则 | 修改弹性伸缩规则 |
| ModifySpecType | 修改计算组的节点规格类型 | 修改计算组的节点规格类型 |
| ModifySpecTypePreCheck | 修改计算组中节点规格类型预检查 | 修改计算组中节点规格类型预检查 |
| QueryEnableMultiAzPrice | 查询开启多可用区的价格 | 查询开启多可用区的价格 |
| QueryMinorVersion | 查询小版本号 | 查询当前主版本对应的最新小版本号 |
| QueryModifyChargeTypePrice | 修改付费类型询价 | StarRocks修改付费类型询价 |
| QueryModifyCuPrice | 修改计算组组节点Cu询价 | 修改计算组组节点Cu询价 |
| QueryModifyDiskNumberPrice | 修改计算组节点磁盘数量询价 | 修改计算组节点磁盘数量询价 |
| QueryModifyDiskPerformanceLevelPrice | 修改计算组节点磁盘性能级别询价 | 修改计算组节点磁盘性能级别询价 |
| QueryModifyDiskSizePrice | 修改计算组节点单盘存储大小询价 | 修改计算组节点单盘存储大小询价 |
| QueryModifyDiskTypePrice | 修改计算组节点磁盘类型询价 | 修改计算组节点磁盘类型询价 |
| QueryModifyNodeNumberPrice | 修改计算组节点数量询价 | 修改计算组节点数量询价 |
| QueryModifySpecTypePrice | 修改计算组规格类型询价 | 修改计算组规格类型询价 |
| QueryPriceV1 | 新购询价 | StarRocks新购询价接口 |
| QueryRefundPrice | 退订包年包月计费实例询价 | StarRocks退订包年包月计费实例询价 |
| QueryRenewPrice | 查询实例的续费价格 | 查询 StarRocks 计费实例的续费价格 |
| RebootECS | 重启集群ECS实例 | 重启集群ECS实例 |
| RenewInstance | 续费实例 | 续费实例 |
| UpdateBackupPolicy | 更新备份策略 | 更新备份策略 |
| UpdateInnerIpWhitelistGroup | 更新内网白名单 | 更新白名单分组中的CIDR |
| UpdateNodeGroupDescription | 更新计算组描述 | 更新计算组描述 |
| UpdatePublicNetworkStatus | 开通/关闭 FE/BE的公网SLB | 开通/关闭 FE/BE的公网SLB。 |
该文章对您有帮助吗？