ライセンスAPI - ライセンスを更新（Update license） - 《Elasticsearchガイドv8.15》日本語

ライセンスAPIの更新
リクエスト
前提条件
説明
クエリパラメータ
リクエストボディ
例

ライセンスAPIの更新

Elasticsearchクラスターのライセンスを更新します。

リクエスト

PUT _license

POST _license

前提条件

Elasticsearchのセキュリティ機能が有効になっている場合、ライセンスをインストールするにはmanage クラスター権限が必要です。
Elasticsearchのセキュリティ機能が有効になっていて、ゴールドまたはそれ以上のライセンスをインストールする場合、ライセンスをインストールする前にトランスポートネットワーク層でTLSを有効にする必要があります。詳細はTLSでノード間通信を暗号化するを参照してください。
オペレーター権限機能が有効になっている場合、このAPIを使用できるのはオペレーターユーザーのみです。

説明

ノードをシャットダウンせずに、実行時にライセンスを更新できます。ライセンスの更新は即座に有効になります。ただし、インストールしているライセンスが以前のライセンスで利用可能だったすべての機能をサポートしていない場合、レスポンスで通知されます。その場合、acknowledgeパラメータをtrueに設定してAPIリクエストを再送信する必要があります。

さまざまなタイプのライセンスについての詳細は、https://www.elastic.co/subscriptionsを参照してください。

クエリパラメータ

acknowledge
(オプション、ブール値) ライセンスの変更を承認するかどうかを指定します。デフォルト値はfalseです。

リクエストボディ

licenses
(必須、配列) ライセンス情報を含む1つ以上のJSONドキュメントのシーケンス。

例

以下の例は、基本ライセンスへの更新を示しています:

Python

resp = client.license.post(
   licenses=[
   {
   "uid": "893361dc-9749-4997-93cb-802e3d7fa4xx",
   "type": "basic",
   "issue_date_in_millis": 1411948800000,
   "expiry_date_in_millis": 1914278399999,
   "max_nodes": 1,
   "issued_to": "issuedTo",
   "issuer": "issuer",
   "signature": "xx"
   }
   ],
)
print(resp)

Js

const response = await client.license.post({
  licenses: [
   {
   uid: "893361dc-9749-4997-93cb-802e3d7fa4xx",
   type: "basic",
   issue_date_in_millis: 1411948800000,
   expiry_date_in_millis: 1914278399999,
   max_nodes: 1,
   issued_to: "issuedTo",
   issuer: "issuer",
   signature: "xx",
   },
  ],
});
console.log(response);

コンソール

PUT _license
{
  "licenses": [
   {
   "uid":"893361dc-9749-4997-93cb-802e3d7fa4xx",
   "type":"basic",
   "issue_date_in_millis":1411948800000,
   "expiry_date_in_millis":1914278399999,
   "max_nodes":1,
   "issued_to":"issuedTo",
   "issuer":"issuer",
   "signature":"xx"
   }
   ]
}

これらの値は無効です。ライセンスファイルから適切な内容に置き換える必要があります。


#### シェル
``````shell
curl -XPUT -u <user> 'http://<host>:<port>/_license' -H "Content-Type: application/json" -d @license.json
`

Windowsでは、次のコマンドを使用します:

シェル

Invoke-WebRequest -uri http://<host>:<port>/_license -Credential elastic -Method Put -ContentType "application/json" -InFile .\license.json

これらの例では、

<user>は適切な権限を持つユーザーIDです。
<host>はElasticsearchクラスター内の任意のノードのホスト名です（ローカルで実行する場合はlocalhost）
<port>はhttpポートです（デフォルトは9200）
license.jsonはライセンスJSONファイルです。

ElasticsearchノードのHTTPインターフェースでSSLが有効になっている場合、URLはhttps://で始める必要があります。

以前に基本ライセンスよりも多くの機能を持つライセンスを持っていた場合、次のレスポンスを受け取ります:

Js

{
  "acknowledged": false,
  "license_status": "valid",
  "acknowledge": {
   "message": """This license update requires acknowledgement. To acknowledge the license, please read the following messages and update the license again, this time with the "acknowledge=true" parameter:""",
   "watcher": [
   "Watcher will be disabled"
   ],
   "logstash": [
   "Logstash will no longer poll for centrally-managed pipelines"
   ],
   "security": [
   "The following X-Pack security functionality will be disabled: ..." ]
   }
}

更新を完了するには、APIリクエストを再送信し、acknowledgeパラメータをtrueに設定する必要があります。例えば:

Python

resp = client.license.post(
   acknowledge=True,
   licenses=[
   {
   "uid": "893361dc-9749-4997-93cb-802e3d7fa4xx",
   "type": "basic",
   "issue_date_in_millis": 1411948800000,
   "expiry_date_in_millis": 1914278399999,
   "max_nodes": 1,
   "issued_to": "issuedTo",
   "issuer": "issuer",
   "signature": "xx"
   }
   ],
)
print(resp)

Js

const response = await client.license.post({
  acknowledge: "true",
  licenses: [
   {
   uid: "893361dc-9749-4997-93cb-802e3d7fa4xx",
   type: "basic",
   issue_date_in_millis: 1411948800000,
   expiry_date_in_millis: 1914278399999,
   max_nodes: 1,
   issued_to: "issuedTo",
   issuer: "issuer",
   signature: "xx",
   },
  ],
});
console.log(response);

コンソール

PUT _license?acknowledge=true
{
  "licenses": [
   {
   "uid":"893361dc-9749-4997-93cb-802e3d7fa4xx",
   "type":"basic",
   "issue_date_in_millis":1411948800000,
   "expiry_date_in_millis":1914278399999,
   "max_nodes":1,
   "issued_to":"issuedTo",
   "issuer":"issuer",
   "signature":"xx"
   }
   ]
}

または:

curl -XPUT -u elastic 'http://<host>:<port>/_license?acknowledge=true' -H "Content-Type: application/json" -d @license.json

ライセンスが期限切れになったときに無効になる機能についての詳細は、ライセンスの期限切れを参照してください。