Path parameters

• deployment_id string Required

  Identifier for the Deployment.

Responses

• 200 application/json

  The heap dump details for all instances belonging to the deployment

  Hide response attributes Show response attributes object

  • elasticsearch array[object] Required

    The list of Elasticsearch resources and their heap dumps

    Hide elasticsearch attributes Show elasticsearch attributes object

    • ref_id string Required

      The locally-unique user-specified id of the resource that the heap dump was captured from

    • id string Required

      The randomly-generated id of a Resource

    • heap_dumps array[object] Required

      The heap dumps belonging to this resource

      Hide heap_dumps attributes Show heap_dumps attributes object

      • instance_id string Required

        The Elastic Cloud name/id of the instance (container)

      • size integer(int64)

        The size in bytes of the heap dump

      • type string Required

        The type of heap dump

      • status string Required

        The status of the heap dump

      • error string

        An error message if the heap dump failed

      • captured string Required

        The time at which the heap dump was captured

  • enterprise_search array[object] Required

    The list of Enterprise Search resources and their heap dumps

    Hide enterprise_search attributes Show enterprise_search attributes object

    • ref_id string Required

      The locally-unique user-specified id of the resource that the heap dump was captured from

    • id string Required

      The randomly-generated id of a Resource

    • heap_dumps array[object] Required

      The heap dumps belonging to this resource

      Hide heap_dumps attributes Show heap_dumps attributes object

      • instance_id string Required

        The Elastic Cloud name/id of the instance (container)

      • size integer(int64)

        The size in bytes of the heap dump

      • type string Required

        The type of heap dump

      • status string Required

        The status of the heap dump

      • error string

        An error message if the heap dump failed

      • captured string Required

        The time at which the heap dump was captured

• 404 application/json

  The deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_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