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

Update Deployment

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
PUT
/deployments/{deployment_id}
Updates a Deployment.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PUT 'http://127.0.0.1/deployments/' \
--header 'Authorization: ApiKey {{EC_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw ''
响应示例响应示例
200 - 示例 1
{
    "name": "string",
    "alias": "string",
    "diagnostics": {
        "creates": {
            "appsearch": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "elasticsearch": [
                {
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "enterprise_search": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "kibana": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "apm": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ]
        },
        "updates": {
            "appsearch": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "elasticsearch": [
                {
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "enterprise_search": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "kibana": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ],
            "apm": [
                {
                    "elasticsearch_cluster_ref_id": "string",
                    "backend_plan": {},
                    "display_name": "string",
                    "ref_id": "string"
                }
            ]
        }
    },
    "shutdown_resources": {
        "appsearch": [
            "string"
        ],
        "elasticsearch": [
            {
                "dependents": [
                    {
                        "kind": "string",
                        "id": "string"
                    }
                ],
                "id": "string"
            }
        ],
        "enterprise_search": [
            "string"
        ],
        "kibana": [
            "string"
        ],
        "apm": [
            "string"
        ]
    },
    "id": "string",
    "resources": [
        {
            "elasticsearch_cluster_ref_id": "string",
            "kind": "string",
            "cloud_id": "string",
            "secret_token": "string",
            "warnings": [
                {
                    "message": "string",
                    "code": "string"
                }
            ],
            "region": "string",
            "ref_id": "string",
            "credentials": {
                "username": "string",
                "password": "string"
            },
            "id": "string"
        }
    ]
}

请求参数

Path 参数

Query 参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200The request was valid and the deployment was updated.
application/json
Body

🟠400The deployment request had errors.
🟠401You are not authorized to perform this action.
🟠404The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)
修改于 2021-10-07 08:42:04
上一页
Get eligible remote clusters
下一页
Get Deployment
Built with