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

Migrate Elasticsearch resource to use ILM

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
Deployments
Migrates the specified Elasticsearch resource to use ILM.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/deployments//elasticsearch//_enable-ilm' \
--header 'Authorization: ApiKey {{EC_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "index_patterns": [
        {
            "index_pattern": "string",
            "node_attributes": {
                "property1": "string",
                "property2": "string"
            },
            "policy_name": "string"
        }
    ]
}'
响应示例响应示例
200 - 示例 1
{
    "warnings": [
        {
            "message": "string",
            "code": "string"
        }
    ]
}

请求参数

Path 参数
deployment_id
必需
Identifier for the Deployment.
ref_id
必需
User-specified RefId for the Resource.
Query 参数
validate_only
可选
When true, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.
Header 参数
Authorization
string 
可选
默认值:
ApiKey {{EC_API_KEY}}
Body 参数application/json
Request sent to enable ILM on a deployment.
index_patterns
array[object (IndexPattern) {3}] 
必需
A locally-unique user-specified id for Kibana
index_pattern
string 
必需
Index pattern to which the ILM policy will be applied.
node_attributes
object 
可选
Defines the Elasticsearch node attributes for the warm element of the topology
policy_name
string 
必需
Name of the policy to create
示例

返回响应

🟢200Standard response
application/json
Body
Response returned when a command is successfully issued against a given Deployment resource
warnings
array[object (ReplyWarning) {2}] 
可选
List of warnings generated from validating command
message
string 
可选
A human readable message describing the warning that occurred
code
string 
必需
A structured code representing the error type that occurred
🟠404* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)
🟠449Elevated permissions are required. (code: `root.unauthorized.rbac.elevated_permissions_required`)
🔴500We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)
上一页
Stop maintenance mode (all instances)
下一页
Shutdown Deployment Stateless Resource
Built with