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

Auth

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

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

Responses

Indicates that the capture has started

application/json

Response Type: object

  • 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)
application/json
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

Response headers

x-cloud-error-codes enum

The error codes associated with the response