オートスケーリングAPI - オートスケーリング容量を取得する（Get autoscaling capacity）

オートスケーリング容量APIの取得
リクエスト
前提条件
説明
レスポンスボディ
例

オートスケーリング容量APIの取得

この機能は、Elasticsearch Service、Elastic Cloud Enterprise、およびElastic Cloud on Kubernetesによる間接的な使用を目的としています。直接の使用はサポートされていません。

オートスケーリング容量を取得します。

リクエスト

Python

resp = client.autoscaling.get_autoscaling_capacity()
print(resp)

Js

const response = await client.autoscaling.getAutoscalingCapacity();
console.log(response);

コンソール

GET /_autoscaling/capacity/

前提条件

Elasticsearchのセキュリティ機能が有効になっている場合、manage_autoscalingクラスター権限を持っている必要があります。詳細については、セキュリティ権限を参照してください。

説明

このAPIは、構成されたオートスケーリングポリシーに基づいて現在のオートスケーリング容量を取得します。このAPIは、現在のワークロードに適切にクラスターのサイズを調整するための情報を返します。


オペレーターは、`````current_nodes`````がオペレーターのクラスターに関する知識と一致することを確認し、古いまたは不完全な情報に基づいてオートスケーリングの決定を行わないようにする必要があります。  
レスポンスには、オートスケーリングが特定の容量が必要であると判断した理由を診断するために使用できる決定者固有の情報が含まれています。この情報は診断のためのものであり、オートスケーリングの決定を行うために使用しないでください。
## クエリパラメータ
-   `````master_timeout

(オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

レスポンスボディ

policies
(オブジェクト) ポリシー名から容量結果へのマップを含みます
```
-   `````<policy_name>
```
- (オブジェクト) ポリシーの容量情報を含みます
```
-   `````required_capacity
```
  - (オブジェクト) ポリシーに必要な容量を含みます。
    required_capacityのプロパティ
  - node
  - (オブジェクト) 各ノードに必要な最小ノードサイズを含み、個々のシャードやMLジョブが単一のノードに収まることを保証します。
```
-   `````storage
```
    - (整数) 各ノードに必要なストレージのバイト数。
    - memory
    - (整数) 各ノードに必要なメモリのバイト数。
    - processors
    - (浮動小数点) 各ノードに必要なプロセッサー(vCPU)の数。
  - total
  - (オブジェクト) ポリシーに必要な総サイズを含みます。
```
-   `````storage
```
    - (整数) ポリシーに必要な総ストレージのバイト数。
    - memory
    - (整数) ポリシーに必要な総メモリのバイト数。
    - processors
    - (浮動小数点) ポリシーに必要なプロセッサー(vCPU)の総数。
  - current_capacity
  - (オブジェクト) ポリシーによって管理されるノードの現在の容量を含みます。つまり、Elasticsearchが計算の基礎とするノードです。
    current_capacityのプロパティ
  - node
  - (オブジェクト) ポリシーによって管理されるノードの最大サイズを含みます。
```
-   `````storage
```
    - (整数) ノードの最大ストレージバイト数。
    - memory
    - (整数) ノードの最大メモリバイト数。
    - processors
    - (浮動小数点) ノードの最大プロセッサー(vCPU)数。
  - total
  - (オブジェクト) ポリシーによって管理されるノードの現在の総ストレージおよびメモリサイズを含みます。
```
-   `````storage
```
    - (整数) ポリシーに利用可能な現在のストレージバイト数。
    - memory
    - (整数) ポリシーに利用可能な現在のメモリバイト数。
    - processors
    - ポリシーに利用可能な現在のプロセッサー(vCPU)数。
  - current_nodes
  - (オブジェクトの配列) 容量計算に使用されるノードのリスト。
    current_nodesの要素のプロパティ
  - name
  - (文字列) ノードの名前。
  - deciders
  - (オブジェクト) 個別の決定者からの容量結果で、外部レベルのrequired_capacityがどのように計算されたかを示します。
    decidersのプロパティ
  - <decider_name>
  - (オブジェクト) ポリシーに対して有効な特定の決定者の容量結果。
```
-   `````required_capacity
```
    - (オブジェクト) 決定者によって決定された必要な容量。
```
-   `````node
```
      - (オブジェクト) 各ノードに必要な最小ノードサイズを含み、個々のシャードや機械学習ジョブが単一のノードに収まることを保証します。
        nodeのプロパティ
      - storage
      - (整数) 各ノードに必要なストレージのバイト数。
      - memory
      - (整数) 各ノードに必要なメモリのバイト数。
      - processors
      - (浮動小数点) 各ノードに必要なプロセッサー(vCPU)の数。
      - total
      - (オブジェクト) ポリシーに必要な総サイズを含みます。
        totalのプロパティ
      - storage
      - (整数) ポリシーに必要な総ストレージのバイト数。
      - memory
      - (整数) ポリシーに必要な総メモリのバイト数。
      - processors
      - (浮動小数点) ポリシーに必要なプロセッサー(vCPU)の総数。
    - reason_summary
    - (文字列) 決定者の結果の基礎に関する説明。
    - reason_details
    - (オブジェクト) 決定者ごとの構造で、決定者の結果の基礎に関する詳細を含みます。内容はアプリケーション目的で信頼されるべきではなく、後方互換性の保証の対象ではありません。

例

この例は、現在のオートスケーリング容量を取得します。

Python

resp = client.autoscaling.get_autoscaling_capacity()
print(resp)

Js

const response = await client.autoscaling.getAutoscalingCapacity();
console.log(response);

コンソール

GET /_autoscaling/capacity

APIは次の結果を返します:

コンソール-結果

{
  policies: {}
}