Capture a new on-demand heap dump for the given instance
editCapture a new on-demand heap dump for the given instance
editCaptures a new on-demand heap dump for the given instance. The capture is completed asynchronously, and you can check its progress by getting heap dumps for the given resource.
Request
editPOST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
The instance identifier |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
|
|
Y |
The kind of resource (one of elasticsearch, kibana or apm). |
Responses
edit-
202
-
Indicates that the capture has started
-
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
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_not_found
,deployments.instance_not_found_error
]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture \ -H "Authorization: ApiKey $ECE_API_KEY"