CapacityPlan - 容量规划-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

用于系统根据业务场景、QPS和日志产生量等情况为您推荐集群容量规划的最佳配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /openapi/assist/actions/capacity-plan HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求参数信息。
complexQueryAvailable	boolean	否	是否具有复杂聚合查询的需求。可选值： true：是 false（默认）：否	true
dataInfo	array<object>	否	磁盘使用情况。
	object	否	dataInfo 信息。
code	string	否	磁盘数据指标代码。可选值： totalRawData：源数据信息 document：数据文档信息，预估文档数 dailyIncrement：数据每日增长量 dailyIncrement：每日增量文档数 retentionTime：数据保留时长 replica：副本设置	totalRawData
size	integer	否	磁盘使用情况指标数值。	100
type	string	否	磁盘数据类型，可选值： hot：热数据 warm：冷数据	hot
unit	string	否	数据单位或时间单位，可选值：数据单位：MiB、GiB、TB、PB 时间单位：DAYS、WEEKS、MONTHS、YEARS	MiB
totalCount	integer	否	数据总条数。	10000
metric	array<object>	否	磁盘使用情况、搜索和写入情况、聚合请求等指标信息。
	object	否	metric 参数信息。
code	string	否	搜索或写入指标代码。可选值： write：写入 search：搜索	write
concurrent	integer	否	并发数。	2
throughput	integer	否	吞吐量，单位：MB/S。	100
type	string	否	搜索/写入峰值类型。可选值： common：常规 peak：高峰	common
peakQps	integer	否	峰值 QPS。	30
averageQps	integer	否	平均 QPS。	30
responseTime	integer	否	期望平均响应时间，单位：毫秒。	100
usageScenario	string	否	使用场景，可选值： general：通用场景 analysisVisualization：数据分析场景 dbAcceleration：数据库加速场景 search：搜索场景 log：日志场景	general

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	当前请求的 ID。	E91B7129-A669-4D9D-A743-F90A0FF1F5EF
Result	object	请求返回结果。
ExtendConfigs	array<object>	拓展配置信息。
	object	ExtendConfigs 信息。
ConfigType	string	配置类型，唯一取值：sharedDisk。说明当规划实例类型为增强版（advanced）时，可能出现的 extendConfigs 属性。	sharedDisk
Disk	integer	磁盘大小，单位：GiB。	2048
DiskType	string	磁盘类型，唯一取值：CPFS_PREMIUM。说明当规划实例类型为增强版（advanced）时，可能出现的 extendConfigs 属性。	CPFS_PREMIUM
InstanceCategory	string	版本类型，取值含义如下： advanced：增强版 x-pack：商业版 community：社区版本	advanced
NodeConfigurations	array<object>	节点信息。
	object	NodeConfigurations 信息。
Amount	integer	节点个数。	10
Cpu	integer	CPU 数量。	1
Disk	integer	磁盘大小，单位：GiB。	20
DiskType	string	硬盘类型，取值含义如下： cloud_essd：ESSD 云盘 cloud_ssd：SSD 云盘 cloud_efficiency：高效云盘 local_ssd：本地 SSD 盘 local_efficiency：本地高效磁盘	cloud_ssd
Memory	integer	当前节点角色的规格内存大小。	2
NodeType	string	节点类型，支持的类型如下： WORKER：数据节点 WORKER_WARM：冷数据节点 MASTER：专有主节点 KIBANA：Kibana 节点 COORDINATING：协调节点 ELASTIC_WORKER：弹性节点	WORKER
OversizedCluster	boolean	根据容量规划计算出来的结果，无默认值。取值含义如下： true：代表超大集群，指容量规划计算出的数据节点数量超过阈值 50。 false：容量规划计算出的数据节点数量在 50 以内。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "E91B7129-A669-4D9D-A743-F90A0FF1F5EF",
  "Result": {
    "ExtendConfigs": [
      {
        "ConfigType": "sharedDisk",
        "Disk": 2048,
        "DiskType": "CPFS_PREMIUM"
      }
    ],
    "InstanceCategory": "advanced",
    "NodeConfigurations": [
      {
        "Amount": 10,
        "Cpu": 1,
        "Disk": 20,
        "DiskType": "cloud_ssd",
        "Memory": 2,
        "NodeType": "WORKER"
      }
    ],
    "OversizedCluster": true
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。