IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Repositories metering APIs Clear repositories metering archive »

› › ›

Get repositories metering information

edit

Get repositories metering information

edit

Returns cluster repositories metering information.

Request

edit

GET /_nodes/<node_id>/_repositories_metering

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Description

edit

You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.

This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts.

Path parameters

edit

<node_id>: (Optional, string) Comma-separated list of node IDs or names used to limit returned information.

All the nodes selective options are explained here.

Response body

edit

_nodes

(object) Contains statistics about the number of nodes selected by the request.

Properties of _nodes

total: (integer) Total number of nodes selected by the request.
successful: (integer) Number of nodes that responded successfully to the request.
failed: (integer) Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

cluster_name

(string) Name of the cluster. Based on the Cluster name setting setting.

nodes

(object) Contains repositories metering information for the nodes selected by the request.

Properties of nodes

<node_id>

(array) An array of repository metering information for the node.

Properties of objects in node_id

repository_name

(string) Repository name.

repository_type

(string) Repository type.

repository_location

(object) Represents an unique location within the repository.

Properties of repository_location for repository type Azure

base_path: (string) The path within the container where the repository stores data.
container: (string) Container name.

Properties of repository_location for repository type GCP

base_path: (string) The path within the bucket where the repository stores data.
bucket: (string) Bucket name.

Properties of repository_location for repository type S3

base_path: (string) The path within the bucket where the repository stores data.
bucket: (string) Bucket name.

repository_ephemeral_id

(string) An identifier that changes every time the repository is updated.

repository_started_at

(long) Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.

repository_stopped_at

(Optional, long) Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch.

archived

(Boolean) A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations.

archive_version

(Optional, long) The cluster state version when this object was archived, this field can be used as a logical timestamp to delete all the archived metrics up to an observed version. This field is only present for archived repository metering information objects. The main purpose of this field is to avoid possible race conditions during repository metering information deletions, i.e. deleting archived repositories metering information that we haven’t observed yet.

request_counts

(object) An object with the number of request performed against the repository grouped by request type.

Properties of request_counts for repository type Azure

GetBlobProperties: (long) Number of Get Blob Properties requests.
GetBlob: (long) Number of Get Blob requests.
ListBlobs: (long) Number of List Blobs requests.
PutBlob: (long) Number of Put Blob requests.
PutBlock: (long) Number of Put Block.
PutBlockList: (long) Number of Put Block List requests.

Azure storage pricing.

Properties of request_counts for repository type GCP

GetObject: (long) Number of get object requests.
ListObjects: (long) Number of list objects requests.
InsertObject: (long) Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation.

Google Cloud storage pricing.

Properties of request_counts for repository type S3

GetObject: (long) Number of GetObject requests.
ListObjects: (long) Number of ListObjects requests.
PutObject: (long) Number of PutObject requests.
PutMultipartObject: (long) Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests.

Amazon Web Services Simple Storage Service pricing.

« Repositories metering APIs Clear repositories metering archive »