CapacityPlan - Elasticsearch - Alibaba Cloud ドキュメントセンター

クラスタのビジネスシナリオ、クエリ/秒、およびログの数に基づいて、クラスタの容量計画のためにシステムによって推奨される構成をクエリします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通のリクエストヘッダー」をご参照ください。

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	説明
	Object	Body	No		リクエストパラメーター情報。
complexQueryAvailable	Boolean	Body	No	true	複雑な集計クエリが必要かどうか。有効な値： true false
dataInfo	Array	Body	No		ディスク使用量データ。
code	String	Body	No	totalRawData	ディスクデータメトリックのコード。有効な値： totalRawData: ソースデータに関する情報。 document: データドキュメント情報、ドキュメントの推定数 dailyIncrement: 1 日あたりのデータ増加量 dailyIncrement: 1 日あたりの増分ドキュメントの数 retentionTime: データの保存期間 replica: レプリカ設定
size	Long	Body	No	100	ディスク使用量メトリックの値。
type	String	Body	No	hot	ディスクのデータタイプ。オプション値： hot: ホットデータ warm: コールドデータ
unit	String	Body	No	MiB	データ単位または時間単位。オプション値：データ単位：MiB、GiB、TB、PB 時間単位：DAYS、WEEKS、MONTHS、YEARS
totalCount	Integer	Body	No	10000	返されるエントリの総数。
metric	Array	Body	No		ディスク使用量、検索と書き込みの状態、集計リクエストなどのメトリック。
code	String	Body	No	write	インジケーターコードを検索または書き込みます。有効な値： write: 書き込み search: 検索
concurrent	Long	Body	No	2	同時スレッド数。
throughput	Long	Body	No	100	スループット。単位：MB/秒。
type	String	Body	No	common	検索/書き込みピークのタイプ。有効な値： common: 従来型 peak: ピーク
peakQps	Integer	Body	No	30	ピークQPS。
averageQps	Integer	Body	No	30	平均QPS。
responseTime	Integer	Body	No	100	予想される平均応答時間。単位：ミリ秒。
usageScenario	String	Body	No	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: Advanced Edition x-pack: Standard Edition community: community バージョン
NodeConfigurations	Array of NodeConfigurations		ノード情報。
Amount	Long	10	コア数。
Cpu	Long	1	vCPU の数。
Disk	Long	20	ディスクのサイズ。単位：GiB。
DiskType	String	cloud_ssd	ハードディスクのタイプ。有効な値： cloud_essd: 拡張SSD（ESSD） cloud_ssd: 標準 SSD cloud_efficiency: Ultra ディスク 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
    } ]
  }
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。