CapacityPlan - Elasticsearch

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

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

Request parameters


Parameter	Type	Position	Required	Example	Description
	Object	Body	No		request parameters information.
complexQueryAvailable	Boolean	Body	No	true	Whether complex aggregate queries are required. Valid values: true false
dataInfo	Array	Body	No		Disk usage data.
code	String	Body	No	totalRawData	The code of the disk data metric. Valid values: totalRawData: the information about the source data. document: data document information, estimated number of documents dailyIncrement: daily data growth dailyIncrement: the number of incremental documents per day retentionTime: the data retention period replica: replica settings
size	Long	Body	No	100	The value of the disk usage metric.
type	String	Body	No	hot	The data type of the disk. Optional values: hot: hot data warm: cold data
unit	String	Body	No	MiB	Data unit or time unit. Optional values: Data units: MiB, GiB, TB, and PB Time units: DAYS, WEEKS, MONTHS, and YEARS
totalCount	Integer	Body	No	10000	The total number of entries returned.
metric	Array	Body	No		Metrics such as disk usage, search and write status, and aggregate requests.
code	String	Body	No	write	Search for or write the indicator code. Valid values: write: write search: search
concurrent	Long	Body	No	2	The number of concurrent threads.
throughput	Long	Body	No	100	The throughput. Unit: MB /s.
type	String	Body	No	common	The type of the search /write peak. Valid values: common: conventional peak: peak
peakQps	Integer	Body	No	30	The peak QPS.
averageQps	Integer	Body	No	30	The average QPS.
responseTime	Integer	Body	No	100	The expected average response time. Unit: milliseconds.
usageScenario	String	Body	No	general	The scenario. Optional values: general: common scenario analysisVisualization: Data analysis scenario dbAcceleration: database acceleration search: the search scenario log: log scenarios

Response parameters


Parameter	Type	Example	Description
RequestId	String	E91B7129-A669-4D9D-A743-F90A0FF1F5EF	The ID of the request.
Result	Object		The data returned.
ExtendConfigs	Array of ExtendConfigs		The configuration information of the extension.
ConfigType	String	sharedDisk	The configuration type. Set the value to sharedDisk. Note The extendConfigs attribute that may appear when the planned instance type is advanced.
Disk	Long	2048	The size of the disk. Unit: GiB.
DiskType	String	CPFS_PREMIUM	The type of the disk. Set the value to CPFS_PREMIUM. Note The extendConfigs attribute that may appear when the planned instance type is advanced.
InstanceCategory	String	advanced	version type. Valid values: advanced: Advanced Edition x-pack: Standard Edition community: community version
NodeConfigurations	Array of NodeConfigurations		The node information.
Amount	Long	10	The number of cores.
Cpu	Long	1	The number of vCPUs.
Disk	Long	20	The size of the disk. Unit: GiB.
DiskType	String	cloud_ssd	The type of the hard disk. Valid values: cloud_essd: enhanced SSD (ESSD) cloud_ssd: standard SSD cloud_efficiency: ultra disk local_ssd: local SSD local_efficiency: Local Efficient Disk
Memory	Long	2	The memory size of the current node role. Unit: GB.
NodeType	String	WORKER	The type of the node. The following types are supported: WORKER: data node WORKER_WARM: cold data nodes MASTER: dedicated master node KIBANA: Kibana node COORDINATING: client node ELASTIC_WORKER: elastic node
OversizedCluster	Boolean	true	The result calculated based on capacity planning. No default value is available. Valid values: true: indicates an ultra-large cluster. The number of data nodes calculated by capacity planning exceeds the threshold of 50. false: The number of data nodes calculated by capacity planning is less than 50.

Examples

Sample requests

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

Sample success response

JSON format

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

Error codes

For a list of error codes, see Service error codes.