Get Deployment
editGet Deployment
editRetrieves information about a Deployment.
Request
editGET /api/v1/deployments/{deployment_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update |
|
|
N |
If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true') |
|
|
N |
If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on |
|
|
N |
Force show the entire plan history no matter how long.
As noted in the |
|
|
N |
If true, will return details for each instance configuration referenced by the deployment. |
|
|
N |
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials |
|
|
N |
If showing plans, whether to show values that are left at their default value (less readable but more informative) |
|
|
N |
Whether to include the plan history with the current and pending plan information. The results can be very large per cluster.
By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans
(which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type:
The first 10 plans, and the last 90 plans for that resource type.
If ALL of the plans are desired, pass the |
|
|
N |
Whether to include with the current and pending plan information the attempt log - can be very large per cluster |
|
|
N |
Whether to include the full current and pending plan information in the response - can be large per cluster |
|
|
N |
Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials |
|
|
N |
Whether to show cluster settings in the response. |
|
|
N |
Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field. |
Responses
edit-
200
-
The Deployment info response
Headers
-
x-cloud-resource-created
(string
) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified
(string
) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version
(string
) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
401
-
You are not authorized to perform this action.
-
404
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id} \ -H "Authorization: ApiKey $ECE_API_KEY"