リポジトリのメータリング情報を取得する

クラスターのリポジトリのメータリング情報を返します。

リクエスト

GET /_nodes/<node_id>/_repositories_metering

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

説明

クラスター内のリポジトリのメータリング情報を取得するために、クラスターリポジトリメータリングAPIを使用できます。

このAPIは単調非減少カウンターを公開しており、クライアントは一定期間にわたって集計を計算するために必要な情報を永続的に保存することが期待されています。さらに、このAPIによって公開される情報は揮発性であり、ノードの再起動後には存在しないことを意味します。

パスパラメータ

  • <node_id>
  • （オプション、文字列）返される情報を制限するために使用されるノードIDまたは名前のカンマ区切りリスト。

すべてのノード選択オプションについては、こちらで説明されています。

レスポンスボディ

  • _nodes
  • （オブジェクト）リクエストによって選択されたノードの統計情報を含みます。 
    1. -   `````total
    • （整数）リクエストによって選択されたノードの総数。
    • successful
    • （整数）リクエストに成功して応答したノードの数。
    • failed
    • （整数）リクエストを拒否したか、応答しなかったノードの数。この値が0でない場合、拒否または失敗の理由がレスポンスに含まれます。
  • cluster_name
  • （文字列）クラスターの名前。クラスター名設定に基づいています。
  • nodes
  • （オブジェクト）リクエストによって選択されたノードのリポジトリメータリング情報を含みます。 
    1. -   `````<node_id>
    • （配列）ノードのリポジトリメータリング情報の配列。 
      1. -   `````repository_name
      • （文字列）リポジトリ名。
      • repository_type
      • （文字列）リポジトリタイプ。
      • repository_location
      • （オブジェクト）リポジトリ内の一意の場所を表します。
        repository_locationのリポジトリタイプAzureのプロパティ
      • base_path
      • （文字列）リポジトリがデータを保存するコンテナ内のパス。
      • container
      • （文字列）コンテナ名。
        repository_locationのリポジトリタイプGCPのプロパティ
      • base_path
      • （文字列）リポジトリがデータを保存するバケット内のパス。
      • bucket
      • （文字列）バケット名。
        repository_locationのリポジトリタイプS3のプロパティ
      • base_path
      • （文字列）リポジトリがデータを保存するバケット内のパス。
      • bucket
      • （文字列）バケット名。
      • repository_ephemeral_id
      • （文字列）リポジトリが更新されるたびに変わる識別子。
      • repository_started_at
      • （長整数）リポジトリが作成または更新された時間。 Unix Epochからのミリ秒で記録されます。
      • repository_stopped_at
      • （オプション、長整数）リポジトリが削除または更新された時間。 Unix Epochからのミリ秒で記録されます。
      • archived
      • （ブール値）このオブジェクトがアーカイブされているかどうかを示すフラグ。リポジトリが閉じられたり更新されたりすると、リポジトリメータリング情報はアーカイブされ、一定期間保持されます。これにより、以前のリポジトリインスタンスのリポジトリメータリング情報を取得できます。
      • cluster_version
      • （オプション、長整数）このオブジェクトがアーカイブされたときのクラスター状態のバージョン。このフィールドは、観測されたバージョンまでのすべてのアーカイブされたメトリックを削除するための論理タイムスタンプとして使用できます。このフィールドは、アーカイブされたリポジトリメータリング情報オブジェクトにのみ存在します。このフィールドの主な目的は、リポジトリメータリング情報の削除中に発生する可能性のある競合状態を回避することです。つまり、まだ観測していないアーカイブされたリポジトリメータリング情報を削除することです。
      • request_counts
      • （オブジェクト）リポジトリに対して行われたリクエストの数をリクエストタイプごとにグループ化したオブジェクト。
        request_countsのリポジトリタイプAzureのプロパティ
      • GetBlobProperties
      • （長整数）Get Blob Propertiesリクエストの数。
      • GetBlob
      • （長整数）Get Blobリクエストの数。
      • ListBlobs
      • （長整数）List Blobsリクエストの数。
      • PutBlob
      • （長整数）Put Blobリクエストの数。
      • PutBlock
      • （長整数）Put Blockの数。
      • PutBlockList
      • （長整数）Put Block Listリクエストの数。
        Azureストレージの料金。
        request_countsのリポジトリタイプGCPのプロパティ
      • GetObject
      • （長整数）get objectリクエストの数。
      • ListObjects
      • （長整数）list objectsリクエストの数。
      • InsertObject
      • （長整数）insert objectリクエストの数。これには、simple、multipart、およびresumableアップロードが含まれます。再開可能なアップロードは、単一のオブジェクトを挿入するために複数のHTTPリクエストを実行できますが、請求は個別の操作として行われるため、単一のリクエストと見なされます。
        Google Cloudストレージの料金。
        request_countsのリポジトリタイプS3のプロパティ
      • GetObject
      • （長整数）GetObjectリクエストの数。
      • ListObjects
      • （長整数）ListObjectsリクエストの数。
      • PutObject
      • （長整数）PutObjectリクエストの数。
      • PutMultipartObject
      • （長整数）Multipartリクエストの数。これには、CreateMultipartUpload、UploadPart、およびCompleteMultipartUploadリクエストが含まれます。
        Amazon Web Services Simple Storage Serviceの料金。