オートスケーリングポリシーAPIの作成または更新

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

指定された名前でオートスケーリングポリシーを作成または更新します。

リクエスト

Python

  1. resp = client.autoscaling.put_autoscaling_policy(
  2. name="<name>",
  3. policy={
  4. "roles": [],
  5. "deciders": {
  6. "fixed": {}
  7. }
  8. },
  9. )
  10. print(resp)

Js

  1. const response = await client.autoscaling.putAutoscalingPolicy({
  2. name: "<name>",
  3. policy: {
  4. roles: [],
  5. deciders: {
  6. fixed: {},
  7. },
  8. },
  9. });
  10. console.log(response);

コンソール

  1. PUT /_autoscaling/policy/<name>
  2. {
  3. "roles": [],
  4. "deciders": {
  5. "fixed": {
  6. }
  7. }
  8. }

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmanage_autoscaling クラスター権限が必要です。
  • オペレーター権限機能が有効になっている場合、オペレーターユーザーのみがこのAPIを使用できます。

説明

このAPIは、提供された名前でオートスケーリングポリシーを設定します。利用可能な決定者については、オートスケーリングデシダーを参照してください。

クエリパラメータ

  • master_timeout
  • (オプション、時間単位)マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • timeout
  • (オプション、時間単位)クラスターのメタデータを更新した後、クラスター内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスターのメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

この例では、固定オートスケーリングデシダーを使用して、my_autoscaling_policyという名前のオートスケーリングポリシーを設定し、(のみ)「data_hot」ロールを持つノードのセットに適用します。

Python

  1. resp = client.autoscaling.put_autoscaling_policy(
  2. name="my_autoscaling_policy",
  3. policy={
  4. "roles": [
  5. "data_hot"
  6. ],
  7. "deciders": {
  8. "fixed": {}
  9. }
  10. },
  11. )
  12. print(resp)

Js

  1. const response = await client.autoscaling.putAutoscalingPolicy({
  2. name: "my_autoscaling_policy",
  3. policy: {
  4. roles: ["data_hot"],
  5. deciders: {
  6. fixed: {},
  7. },
  8. },
  9. });
  10. console.log(response);

コンソール

  1. PUT /_autoscaling/policy/my_autoscaling_policy
  2. {
  3. "roles" : [ "data_hot" ],
  4. "deciders": {
  5. "fixed": {
  6. }
  7. }
  8. }

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

コンソール-結果

  1. {
  2. "acknowledged": true
  3. }