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
    } ]
  }
}

錯誤碼

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