Get Deployment Enterprise Search Resource Info

开发环境

http://127.0.0.1

GET

/deployments/{deployment_id}/enterprise_search/{ref_id}

Deployments

Get info about an Enterprise Search Resource belonging to a given Deployment.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - 示例 1

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment

ref_id

必需

User-specified RefId for the Resource

Query 参数

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

show_settings

可选

Whether to show cluster settings in the response.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200Standard response.

application/json

Body

Describes an Enterprise Search resource belonging to a Deployment

elasticsearch_cluster_ref_id

string

必需

The Elasticsearch cluster that this resource depends on.

info

object (EnterpriseSearchInfo)

必需

The overview information for the Enterprise Search Server.

status

enum<string>

必需

Enterprise Search status

枚举值:

initializingstoppingstoppedrebootingrestartingreconfiguringstarted

name

string

必需

The name of the Enterprise Search

links

object

可选

A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

elasticsearch_cluster

object (TargetElasticsearchCluster)

必需

Information about the specified Elasticsearch cluster.

healthy

boolean

必需

Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)

region

string

可选

The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.

settings

object (EnterpriseSearchSettings)

可选

The settings for the Enterprise Search.

plan_info

object (EnterpriseSearchPlansInfo)

必需

Information about current, pending, and past Enterprise Search Server plans.

external_links

array[object (ExternalHyperlink) {3}]

必需

External resources related to the Enterprise Search

deployment_id

string

可选

The id of the deployment that this Enterprise Search belongs to.

topology

object (ClusterTopologyInfo)

必需

The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

string

必需

The id of the Enterprise Search

metadata

object (ClusterMetadataInfo)

可选

Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

region

string

必需

The region where this resource exists

string

必需

The randomly-generated id of a Resource

ref_id

string

必需

The locally-unique user-specified id of a Resource

🟠404The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)

🔴500We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)

Reset the secret token for an APM resource.

Get Deployment Kibana Resource Info