Capture a new on-demand heap dump for the given instance
Captures 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.
Path parameters
-
Identifier for the Deployment.
-
The kind of resource (one of elasticsearch, kibana or apm).
-
User-specified RefId for the Resource (or '_main' if there is only one).
-
The instance identifier
Responses
-
Indicates that the capture has started
Additional properties are allowed.
-
- 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 Deployment specified by {deployment_id} cannot be found. (code:
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
curl \
-X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
Response examples (202)
{}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}