Headers

• Accept string

  Accept header containing the content preference.

Path parameters

• organization_id string Required

  Identifier for the organization

Query parameters

• from string

  A datetime for the beginning of the desired range for which to fetch activity. Defaults to start of current month.

• to string

  A datetime for the end of the desired range for which to fetch activity. Defaults to the current date.

Responses

• 200

  The costs associated to a set of products

  Hide response attributes Show response attributes object

  Costs associated to a set of deployments for an organization. All of the costs are expressed in Elastic Consumption Unit (ECU).

  • total_cost number(double) Required

    Total cost for all deployments

  • deployments array[object] Required

    Costs of the list of deployments

    Hide deployments attributes Show deployments attributes object

    Detailed costs for a deployment for an organization. All of the costs are expressed in Elastic Consumption Unit (ECU).

    • deployment_id string Required

      Elasticsearch deployment id

    • deployment_name string Required

      Elasticsearch deployment name

    • costs object Required

      Costs for the organization

      Hide costs attributes Show costs attributes object

      • total number(double) Required

        Total costs

      • dimensions array[object] Required

        A collection of billing details by dimension.

        Hide dimensions attributes Show dimensions attributes object

        Billing dimension

        • type string Required

          The type of the billing dimension

          Values are capacity, data_in, data_internode, data_out, storage_api, or storage_bytes.

        • cost number(double) Required

          The cost of the billing dimension

    • hourly_rate number(double) Required

      Price per hour

    • period object

      Period

      Hide period attributes Show period attributes object

      • start string(date-time) Required

        Start

      • end string(date-time) Required

        End

• 400

  Invalid date range specified. (code: costs.invalid_date_range)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is costs.invalid_date_range.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 403

  The current user does not have access to the requested organization. (code: organization.invalid_access)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.invalid_access.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 404

  Organization not found. (code: organization.not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 500

  An error occurred when fetching the costs associated with all deployments for the organization. (code: billing_service.failed_request)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is billing_service.failed_request.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields