IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Capture diagnostics for an Elasticsearch or Kibana resource
editCapture diagnostics for an Elasticsearch or Kibana resourceedit
Retrieves a diagnostic bundle from an active cluster. To successfully retrieve a diagnostic bundle, the cluster must be responsive.
Requestedit
POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of resource (one of elasticsearch or kibana). |
Responsesedit
-
200
-
(
string
asbyte
)The diagnostic bundle as a zip file
-
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
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_not_found
]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
412
-
The diagnostics cannot be generated because the cluster is either stopped or initializing. (code:
clusters.cluster_plan_state_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_plan_state_error
]) - The error codes associated with the response
-
-
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 -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture \ -H "Authorization: ApiKey $ECE_API_KEY"