Elasticsearch API
  1. Deployments
Elasticsearch API
  • Accounts
    • Updates the current account
    • Updates the current account
    • Fetch current account information
  • Authentication
    • Delete API key
    • Get API key
    • Create API key
    • Delete API keys
    • Get all API keys
  • BillingCostsAnalysis
    • Get costs overview for the organization
    • Get deployments costs for the organization
    • Get itemized costs for the organization
    • Get itemized costs by deployments
  • DeploymentTemplates
    • Get deployment templates
    • Get deployment template
  • Deployments
    • Shutdown Deployment Elasticsearch Resource
      POST
    • Start all instances
      POST
    • Restores a shutdown resource
      POST
    • Restores a shutdown Deployment
      POST
    • Set remote clusters
      PUT
    • Get remote clusters
      GET
    • Stop instances
      POST
    • Reset the secret token for an APM resource.
      POST
    • Get Deployment Enterprise Search Resource Info
      GET
    • Get Deployment Kibana Resource Info
      GET
    • Set AppSearch read-only status
      PUT
    • Set AppSearch read-only status
      GET
    • Start instances
      POST
    • Restart Deployment Stateless Resource
      POST
    • Shuts down Deployment
      POST
    • Migrate Elasticsearch resource to use SLM
      POST
    • Start maintenance mode
      POST
    • Restart Deployment Elasticsearch Resource
      POST
    • Start maintenance mode (all instances)
      POST
    • Reset 'elastic' user password
      POST
    • Stop all instances
      POST
    • Migrate Elasticsearch and associated Kibana resources to enable CCR
      POST
    • Add or remove settings from the Elasticsearch resource keystore
      PATCH
    • Get the settings from the Elasticsearch resource keystore
      GET
    • Search Deployments
      POST
    • Get eligible remote clusters
      POST
    • Update Deployment
      PUT
    • Get Deployment
      GET
    • Get Deployment Elasticsearch Resource Info
      GET
    • Stop maintenance mode (all instances)
      POST
    • Migrate Elasticsearch resource to use ILM
      POST
    • Shutdown Deployment Stateless Resource
      POST
    • Get Deployment APM Resource Info
      GET
    • Stop maintenance mode
      POST
    • Cancel resource pending plan
      DELETE
    • Get Deployment App Search Resource Info
      GET
    • Get eligible remote clusters
      POST
    • Create Deployment
      POST
    • List Deployments
      GET
    • Upgrade Kibana, APM, AppSearch inside Deployment
      POST
  • DeploymentsTrafficFilter
    • Delete ruleset association
    • Create ruleset association
    • Get associated deployments
    • Create a ruleset
    • List traffic filter rulesets
    • Get associated rulesets
    • Updates a ruleset
    • Delete a ruleset
    • Retrieves the ruleset by ID.
  • Extensions
    • Create an extension
    • List Extensions
    • Uploads the Extension
    • Update Extension
    • Delete Extension
    • Get Extension
  • Stack
    • Get stack versions
  1. Deployments

Search Deployments

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
POST
/deployments/_search
Deployments
Retrieves the information for all of the deployments that match the specified query.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/deployments/_search' \
--header 'Authorization: ApiKey {{EC_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw ''
响应示例响应示例

请求参数

Header 参数
Authorization
string 
可选
默认值:
ApiKey {{EC_API_KEY}}
Body 参数application/json
An Elasticsearch search request with a subset of options.
sort
array [object] 
可选
An array of fields to sort the search results by.
query
object (QueryContainer) 
可选
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
match_all
object (MatchAllQuery) 
可选
A query that matches all documents.
exists
object (ExistsQuery) 
可选
Matches documents that have at least one non-null value in the original field.
term
object 
可选
nested
object (NestedQuery) 
可选
A query that matches nested objects.
prefix
object 
可选
bool
object (BoolQuery) 
可选
A query for documents that match boolean combinations of other queries.
query_string
object (QueryStringQuery) 
可选
A query that uses the SimpleQueryParser for parsing.
range
object 
可选
match_none
object (MatchNoneQuery) 
可选
A query that doesn't match any documents.
match
object 
可选
from
integer <int32>
可选
size
integer <int32>
可选
The maximum number of search results to return.
示例

返回响应

🟢200The list of deployments that match the specified query and belong to the authenticated user.
application/json
Body
Contains a list of Deployments as result of a search request.
match_count
integer <int32>
可选
If a query is supplied, then the total number of deployments that matched
return_count
integer <int32>
必需
The number of deployments actually returned
deployments
array[object (DeploymentSearchResponse) {7}] 
必需
name
string 
必需
The name of this deployment
settings
object (DeploymentSettings) 
可选
Additional configuration about the current deployment object.
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
id
string 
必需
A randomly-generated id of this Deployment
resources
object (DeploymentResources) 
必需
Describes a resource belonging to a Deployment
metadata
object (DeploymentMetadata) 
可选
Additional information about the current deployment object.
上一页
Get the settings from the Elasticsearch resource keystore
下一页
Get eligible remote clusters
Built with