IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Download the given instance’s heap dumpedit
Returns the given instance's heap dump for download.
Requestedit
GET /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
The instance identifier |
|
|
Y |
User-specified RefId for the Resource. |
|
|
Y |
The kind of resource (one of elasticsearch, kibana or apm). |
Responsesedit
-
200
-
(
string
asbyte
)The given instance's heap dump
-
404
-
-
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
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
449
-
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 exampleedit
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"