調用CapacityPlan，用于系統根據業務場景、QPS和日志產生量等情況為您推薦集群容量規劃的最佳配置信息。

調試

您可以在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
    } ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。