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

Restart Deployment Elasticsearch Resource

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
Deployments
Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/deployments//elasticsearch//_restart' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'
响应示例响应示例
202 - 示例 1
{
    "warnings": [
        {
            "message": "string",
            "code": "string"
        }
    ]
}

请求参数

Path 参数
deployment_id
必需
Identifier for the Deployment.
ref_id
必需
User-specified RefId for the Resource.
Query 参数
restore_snapshot
可选
When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).
skip_snapshot
可选
If true, will not take a snapshot of the cluster before restarting.
cancel_pending
可选
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.
group_attribute
可选
Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '__all__' (restart all at once), '__zone__' by logical zone, '__name__' one instance at a time, or a comma-separated list of attributes of the instances
shard_init_wait_time
可选
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)
Header 参数
Authorization
string 
可选
默认值:
ApiKey {{EC_API_KEY}}

返回响应

🟢202The restart command was issued successfully.
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`)
🟠422The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: `deployments.deployment_resource_plan_change_error`)
🟠449Elevated permissions are required. (code: `root.unauthorized.rbac.elevated_permissions_required`)
🔴500A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)
上一页
Start maintenance mode
下一页
Start maintenance mode (all instances)
Built with