全部API接口参考与说明-开源大数据平台 E-MapReduce-阿里云

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

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

实例管理

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概述
CreateServiceLinkedRole	创建服务角色	该接口用于为用户创建 AliyunServiceRoleForEMRStarRocks 角色。