Elasticsearch API
  1. DeploymentTemplates
Elasticsearch API
  • Accounts
    • Updates the current account
      PUT
    • Updates the current account
      PATCH
    • Fetch current account information
      GET
  • Authentication
    • Delete API key
      DELETE
    • Get API key
      GET
    • Create API key
      POST
    • Delete API keys
      DELETE
    • Get all API keys
      GET
  • BillingCostsAnalysis
    • Get costs overview for the organization
      GET
    • Get deployments costs for the organization
      GET
    • Get itemized costs for the organization
      GET
    • Get itemized costs by deployments
      GET
  • DeploymentTemplates
    • Get deployment templates
      GET
    • Get deployment template
      GET
  • 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. DeploymentTemplates

Get deployment template

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
GET
/deployments/templates/{template_id}
DeploymentTemplates
Retrieves a deployment template by id.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://127.0.0.1/deployments/templates/?region=' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'
响应示例响应示例
200 - 示例 1

请求参数

Path 参数
template_id
必需
The identifier for the deployment template.
Query 参数
show_instance_configurations
可选
If true, will return details for each instance configuration referenced by the template.
show_max_zones
可选
If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.
stack_version
可选
If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.
region
必需
Region of the deployment template
Header 参数
Authorization
string 
可选
默认值:
ApiKey {{EC_API_KEY}}

返回响应

🟢200The deployment template was found and returned successfully.
application/json
Body
Deployment template detailed information
instance_configurations
array[object (InstanceConfigurationInfo) {9}] 
必需
List of instance configurations used in the cluster template.
discrete_sizes
object (DiscreteSizes) 
必需
Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.
description
string 
可选
Optional description for the instance configuration
node_types
array[string]
可选
Node types (master, data) for the instance
storage_multiplier
number <double>
可选
Settings for the instance storage multiplier
instance_type
string 
必需
The type of instance (elasticsearch, kibana)
cpu_multiplier
number <double>
可选
Settings for the instance CPU multiplier
max_zones
integer <int32>
只读可选
The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.
id
string 
可选
Unique identifier for the instance configuration
name
string 
必需
Display name for the instance configuration.
description
string 
可选
An optional description for the template.
template_category_id
string 
可选
Provider and version agnostic template identifier used for grouping related template types.
min_version
string 
可选
Minimum stack version required by this template, if any.
kibana_deeplink
array[object (KibanaDeeplink) {2}] 
可选
The Kibana Deeplink for this type of deployment.
semver
string 
必需
Semver condition when to apply the URI.
uri
string 
必需
URI to which the user should be directed.
id
string 
必需
The unique identifier for the template.
order
integer <int32>
可选
Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
source
object (ChangeSourceInfo) 
可选
A container for information about the source of a change.
user_id
string 
可选
The user that requested the change
remote_addresses
array[string]
可选
The host addresses of the user that originated the change
facilitator
string 
必需
The service where the change originated from
admin_id
string 
可选
The admin user that requested the change
date
string <date-time>
必需
The time the change was initiated
action
string 
必需
The type of plan change that was initiated
deployment_template
object (DeploymentCreateRequest) 
必需
A request for creating a new Deployment consisting of multiple clusters
alias
string 
可选
A user-defined alias to use in place of Cluster IDs for user-friendly URLs
metadata
object (DeploymentCreateMetadata) 
可选
Additional information about the new deployment object.
name
string 
可选
A name for the deployment; otherwise this will be the generated deployment id
resources
object (DeploymentCreateResources) 
必需
Describes the resources that will belong to a Deployment
settings
object (DeploymentCreateSettings) 
可选
Additional configuration for the new deployment object.
metadata
array[object (MetadataItem) {2}] 
可选
Optional arbitrary metadata to associate with this template.
value
string 
必需
The metadata value
key
string 
必需
The metadata field name
system_owned
boolean 
可选
Whether or not if this is system owned template.
name
string 
必需
A human readable name for the template.
🟠400The requested region is not supported. (code: `templates.region_not_found`)
🟠401The user is not authorized to access requested region. (code: `templates.region_not_allowed`)
🟠404The deployment template specified by {template_id} cannot be found. (code: `templates.template_not_found`)
上一页
Get deployment templates
下一页
Shutdown Deployment Elasticsearch Resource
Built with