Path parameters

• node_id string | array[string] Required

  Comma-separated list of node IDs or names used to limit returned information.

• max_archive_version number Required

  Specifies the maximum archive_version to be cleared from the archive.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • _nodes object

    Contains statistics about the number of nodes selected by the request’s node filters.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason
      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by
      • root_cause array[object]
      • suppressed array[object]
    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      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 Required

    Name of the cluster. Based on the cluster.name setting.

  • nodes object Required

    Contains repositories metering information for the nodes selected by the request.

    Hide nodes attribute Show nodes attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • repository_name string Required

        Repository name.

      • repository_type string Required

        Repository type.

      • repository_location object Required

        Represents an unique location within the repository.

        Hide repository_location attributes Show repository_location attributes object

        • base_path string Required
        • container string

          Container name (Azure)

        • bucket string

          Bucket name (GCP, S3)

      • repository_ephemeral_id string Required

        An identifier that changes every time the repository is updated.

      • repository_started_at number

        Time unit for milliseconds

      • repository_stopped_at number

        Time unit for milliseconds

      • archived boolean Required

        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_version number

        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 Required

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

        Hide request_counts attributes Show request_counts attributes object

        • GetBlobProperties number

          Number of Get Blob Properties requests (Azure)

        • GetBlob number

          Number of Get Blob requests (Azure)

        • ListBlobs number

          Number of List Blobs requests (Azure)

        • PutBlob number

          Number of Put Blob requests (Azure)

        • PutBlock number

          Number of Put Block (Azure)

        • PutBlockList number

          Number of Put Block List requests

        • GetObject number

          Number of get object requests (GCP, S3)

        • ListObjects number

          Number of list objects requests (GCP, S3)

        • InsertObject number

          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)

        • PutObject number

          Number of PutObject requests (S3)

        • PutMultipartObject number

          Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)