Path parameters

• node_id string | array[string] Required

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

Responses

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

  • _nodes object

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

    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 string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

      • caused_by 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.

      • root_cause 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.

        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.

      • suppressed 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.

        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.

    • 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
  • 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_type string Required

        Repository type.

      • repository_location object Required
        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

      • Time unit for milliseconds

      • 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
      • request_counts object Required
        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)