Download the given instance’s heap dump

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Download the given instance’s heap dump

edit

Returns the given instance's heap dump for download.

Request

edit

GET /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`instance_id`	`string`	Y	The instance identifier
`ref_id`	`string`	Y	User-specified RefId for the Resource.
`resource_kind`	`string`	Y	The kind of resource (one of elasticsearch, kibana or apm).

Responses

edit

200

(string as byte)

The given instance's heap dump

404

(BasicFailedReply)

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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found, deployments.instance_not_found_error, heap_dumps.heap_dump_not_found]): The error codes associated with the response

449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): The error codes associated with the response

Request example

edit

curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download \
-H "Authorization: ApiKey $ECE_API_KEY"

« Capture a new on-demand heap dump for the given instance Capture a new thread dump for the given instance »