Get Deployment

开发环境

http://127.0.0.1

GET

/deployments/{deployment_id}

Deployments

Retrieves information about a Deployment.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1/deployments/' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment

Query 参数

show_security

可选

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

show_metadata

可选

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plans

可选

Whether to include the full current and pending plan information in the response - can be large per cluster

show_plan_logs

可选

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plan_history

可选

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_defaults

可选

If showing plans, whether to show values that are left at their default value (less readable but more informative)

convert_legacy_plans

可选

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')

show_system_alerts

可选

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.

show_settings

可选

Whether to show cluster settings in the response.

enrich_with_template

可选

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200The Deployment info response

application/json

Body

Describes a given Deployment

name

string

必需

The name of this deployment

settings

object (DeploymentSettings)

可选

Additional configuration about the current deployment object.

ip_filtering_settings

object (IpFilteringSettings)

可选

The configuration settings for IP filtering.

observability

object (DeploymentObservabilitySettings)

可选

The observability settings for a deployment

traffic_filter_settings

object (TrafficFilterSettings)

可选

The configuration settings for the traffic filter.

healthy

boolean

必需

Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)

alias

string

可选

A user-defined deployment alias for user-friendly resource URLs

observability

object (DeploymentObservability)

可选

Observability information for a deployment

healthy

boolean

必需

Whether the deployment observability is healthy or not (one or more of the subsections will have healthy: false)

metrics

object (DeploymentMetrics)

可选

Metrics information for a deployment

logging

object (DeploymentLogging)

可选

Logging information for a deployment

issues

array[object (ObservabilityIssue) {2}]

可选

General observability health issues for the deployment

string

必需

A randomly-generated id of this Deployment

resources

object (DeploymentResources)

必需

Describes a resource belonging to a Deployment

appsearch

array[object (AppSearchResourceInfo) {5}]

必需

List of App Search resources in your Deployment

elasticsearch

array[object (ElasticsearchResourceInfo) {4}]

必需

List of Elasticsearch resources in your Deployment

enterprise_search

array[object (EnterpriseSearchResourceInfo) {5}]

必需

List of Enterprise Search resources in your Deployment

kibana

array[object (KibanaResourceInfo) {5}]

必需

List of Kibana resources in your Deployment

apm

array[object (ApmResourceInfo) {5}]

必需

List of Apm resources in your Deployment

metadata

object (DeploymentMetadata)

可选

Additional information about the current deployment object.