Get Deploymentedit
Retrieves information about a Deployment.
Requestedit
GET /api/v1/deployments/{deployment_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
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 |
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 with the current and pending plan information the plan history- can be very large per cluster |
|
|
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. |
Responsesedit
-
200
-
(
DeploymentGetResponse
) The Deployment info responseHeaders
-
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
-
(
BasicFailedReply
) You are not authorized to perform this action -
404
-
(
BasicFailedReply
) The Deployment specified by {deployment_id} cannot be found -
500
-
(
BasicFailedReply
) We have failed you.
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XGET {{hostname}}/api/v1/deployments/{deployment_id} \ -H "Authorization: ApiKey $ECE_API_KEY"