AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityExperimental since 7.16This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Get repositories metering information for a cluster.
This API exposes monotonically non-decreasing counters and it is 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 will not be present after node restarts.
Number of nodes that responded successfully to the request.
failednumberrequired
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_namestringrequired
Name of the cluster. Based on the cluster.name setting.
nodesmapstring to objectrequired
Contains repositories metering information for the nodes selected by the request.
<string>object
repository_namestringrequired
Repository name.
repository_typestringrequired
Repository type.
repository_locationobjectrequired
Represents an unique location within the repository.
base_pathstringrequired
containerstring
Container name (Azure)
bucketstring
Bucket name (GCP, S3)
repository_ephemeral_idstringrequired
An identifier that changes every time the repository is updated.
repository_started_atnumberrequired
Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.
repository_stopped_atnumber
Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch.
archivedbooleanrequired
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.
cluster_versionnumber
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_countsobjectrequired
An object with the number of request performed against the repository grouped by request type.
GetBlobPropertiesnumber
Number of Get Blob Properties requests (Azure)
GetBlobnumber
Number of Get Blob requests (Azure)
ListBlobsnumber
Number of List Blobs requests (Azure)
PutBlobnumber
Number of Put Blob requests (Azure)
PutBlocknumber
Number of Put Block (Azure)
PutBlockListnumber
Number of Put Block List requests
GetObjectnumber
Number of get object requests (GCP, S3)
ListObjectsnumber
Number of list objects requests (GCP, S3)
InsertObjectnumber
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. (GCP)
PutObjectnumber
Number of PutObject requests (S3)
PutMultipartObjectnumber
Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)