Get details about heap dumps for a Deployment

Auth

Gets details about existing heap dumps and in progress heap dump captures across all instances belonging to the deployment.

Path parameters

deployment_id string required

Identifier for the Deployment.

Responses

The heap dump details for all instances belonging to the deployment

application/json
elasticsearch object[] required

The list of Elasticsearch resources and their heap dumps

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 object[] required

The heap dumps belonging to this resource

instance_id string required

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

size integer · format: 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

The list of Enterprise Search resources and their heap dumps

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 object[] required

The heap dumps belonging to this resource

instance_id string required

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

size integer · format: 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

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

application/json
errors object[] required

A list of errors that occurred in the failing request

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 string[]

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

Response headers

x-cloud-error-codes enum

The error codes associated with the response