Get cluster repositories metering
- GET /_nodes/{node_id}/_repositories_metering
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.
- Cluster privileges:
monitor,manage
Path Parameters
-
node_idNodeId | NodeIdrequired -
Comma-separated list of node IDs or names used to limit returned information.
Response
-
_nodesNodeStatistics -
Contains statistics about the number of nodes selected by the request’s node filters.
-
failuresErrorCause -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
totalnumberrequired -
Total number of nodes selected by the request.
-
successfulnumberrequired -
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_namestring Namerequired -
Name of the cluster. Based on the
cluster.namesetting. -
nodesmap string to RepositoryMeteringInformationrequired -
Contains repositories metering information for the nodes selected by the request.
-
<string>RepositoryMeteringInformation -
repository_namestring Namerequired -
Repository name.
-
repository_typestringrequired -
Repository type.
-
repository_locationRepositoryLocationrequired -
Represents an unique location within the repository.
-
repository_ephemeral_idstring Idrequired -
An identifier that changes every time the repository is updated.
-
repository_started_atEpochTimeUnitMillisrequired -
Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.
-
repository_stopped_atEpochTimeUnitMillis -
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 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_countsRequestCountsrequired -
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)