Path parameters

  • node_idstring | array[string] Required

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

  • max_archive_versionnumber Required

    Specifies the maximum archive_version to be cleared from the archive.

Responses

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

      Contains statistics about the number of nodes selected by the request.

      Hide _nodes attributes Show _nodes attributes object
      • failuresarray[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
        • typestring Required

          The type of error

        • reasonstring | null

          A human-readable explanation of the error, in English.

          One of:
          string-1stringstring-2string | null
        • stack_tracestring

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

        • caused_byobject

          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.

        • root_causearray[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.

          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.

        • suppressedarray[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.

          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.

      • totalnumber Required

        Total number of nodes selected by the request.

      • successfulnumber Required

        Number of nodes that responded successfully to the request.

      • failednumber 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_namestring Required
    • nodesobject 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_namestring Required
        • repository_typestring Required

          Repository type.

        • repository_locationobject Required
          Hide repository_location attributes Show repository_location attributes object
        • repository_ephemeral_idstring Required

        • Time unit for milliseconds

        • Time unit for milliseconds

        • archivedboolean 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_versionnumber
        • request_countsobject Required
          Hide request_counts attributes Show request_counts attributes object
          • 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)

DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
curl \
 --request DELETE 'http://api.example.com/_nodes/{node_id}/_repositories_metering/{max_archive_version}' \
 --header "Authorization: $API_KEY"