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 dump Restart Deployment Stateless Resource »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Deployment - Commands

Capture a new thread dump for the given instance

edit

Capture a new thread dump for the given instance

edit

Captures a new thread dump for the given instance and returns the thread dump contents.

Request

edit

POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture

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 thread dump contents

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)

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

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture \
-H "Authorization: ApiKey $ECE_API_KEY"
« Download the given instance’s heap dump Restart Deployment Stateless Resource »