Download the given instance's heap dump
Auth
Returns the given instance's heap dump for download.
-
deployment_id
string
required
-
Identifier for the Deployment.
-
resource_kind
string
required
-
The kind of resource (one of elasticsearch, kibana or apm).
-
ref_id
string
required
-
User-specified RefId for the Resource (or '_main' if there is only one).
-
instance_id
string
required
-
The instance identifier
The given instance's heap dump
Response Type: string · format: byte
- The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found)
- The specified instance cannot be found. (code:
deployments.instance_not_found_error)
- The specified instance does not have a heap dump available to download. (code:
heap_dumps.heap_dump_not_found)
-
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