CapacityPlan - 检索分析服务Elasticsearch版

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数


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

返回数据


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

示例

请求示例

POST /openapi/assist/actions/capacity-plan HTTP/1.1
Content-Type:application/json

{
  "complexQueryAvailable" : true,
  "dataInfo" : [ {
    "code" : "totalRawData",
    "size" : 100,
    "type" : "hot",
    "unit" : "MiB",
    "totalCount" : 10000
  } ],
  "metric" : [ {
    "code" : "write",
    "concurrent" : 2,
    "throughput" : 100,
    "type" : "common",
    "peakQps" : 30,
    "averageQps" : 30,
    "responseTime" : 100
  } ],
  "usageScenario" : "general"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E91B7129-A669-4D9D-A743-F90A0FF1F5EF",
  "Result" : {
    "instanceCategory" : "advanced",
    "oversizedCluster" : true,
    "nodeConfigurations" : [ {
      "amount" : 3943,
      "diskType" : "cloud_ssd",
      "disk" : 20,
      "nodeType" : "WORKER",
      "cpu" : 32,
      "memory" : 128
    }, {
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20,
      "nodeType" : "MASTER",
      "cpu" : 2,
      "memory" : 8
    }, {
      "amount" : 3,
      "diskType" : "cloud_efficiency",
      "disk" : 20,
      "nodeType" : "COORDINATING",
      "cpu" : 2,
      "memory" : 8
    }, {
      "amount" : 7,
      "diskType" : "cloud_efficiency",
      "nodeType" : "WORKER_WARM",
      "cpu" : 4,
      "memory" : 32
    }, {
      "amount" : 1,
      "nodeType" : "KIBANA",
      "cpu" : 1,
      "memory" : 2
    } ],
    "extendConfigs" : [ {
      "configType" : "sharedDisk",
      "diskType" : "CPFS_PREMIUM",
      "disk" : 3943000
    } ]
  }
}

错误码

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