Update Deployment

开发环境

http://127.0.0.1

PUT

/deployments/{deployment_id}

Deployments

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 参数

deployment_id

必需

Identifier for the Deployment

Query 参数

hide_pruned_orphans

可选

Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)

skip_snapshot

可选

Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)

validate_only

可选

If true, will just validate the Deployment definition but will not perform the update

version

可选

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

Body 参数application/json

A request for updating a Deployment consisting of multiple resources

name

string

可选

A new name for the deployment, otherwise stays the same.

settings

object (DeploymentUpdateSettings)

可选

Additional configuration for the new deployment object.

observability

object (DeploymentObservabilitySettings)

可选

The observability settings for a deployment

prune_orphans

boolean

必需

Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.

alias

string

可选

A user-defined alias to use in place of Cluster IDs for user-friendly URLs

resources

object (DeploymentUpdateResources)

可选

Describes the resources that will have the Deployment

appsearch

array[object (AppSearchPayload) {6}]

可选

A list of payloads for AppSearch updates

elasticsearch

array[object (ElasticsearchPayload) {5}]

可选

A list of payloads for Elasticsearch cluster updates

kibana

array[object (KibanaPayload) {6}]

可选

A list of payloads for Kibana updates

apm

array[object (ApmPayload) {6}]

可选

A list of payloads for APM updates

metadata

object (DeploymentUpdateMetadata)

可选

Additional information about the current deployment object.

返回响应

🟢200The request was valid and the deployment was updated.

application/json

Body

A response returned from the Deployment update endpoint

name

string

必需

The name of the deployment

alias

string

可选

A user-defined alias to use in place of ResourceIds for user-friendly resource URLs

diagnostics

object (DeploymentDiagnostics)

可选

Describes the diagnostics for a given Deployment-modifying payload

creates

object (Creates)

可选

Holds diagnostics for resources that will be created

updates

object (Updates)

可选

Holds diagnostics for existing resources that might be updated

shutdown_resources

object (Orphaned)

可选

Details about orphaned resources.

appsearch

array[string]

必需

List of orphaned AppSearch resource ids

elasticsearch

array[object (OrphanedElasticsearch) {2}]

必需

List of orphaned Elasticsearch resources

enterprise_search

array[string]

必需

List of orphaned Enterprise Search resource ids

kibana

array[string]

必需

List of orphaned Kibana resource ids

apm

array[string]

必需

List of orphaned APM resource ids

string

必需

The id of the deployment

resources

array[object (DeploymentResource) {9}]

必需

List of resources that are part of the deployment after the update operation.

elasticsearch_cluster_ref_id

string

可选

The Elasticsearch cluster that this resource depends on.

kind

string

必需

The kind of resource

cloud_id

string

可选

An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana

secret_token

string

可选

Secret token for using a created resource. Only provided on initial create and absent otherwise.

warnings

array[object (ReplyWarning) {2}]

可选

List of warnings generated from validating resource updates

region

string

必需

Identifier of the region in which this resource runs.

ref_id

string

必需

A locally-unique friendly alias for this Elasticsearch cluster

credentials

object (ClusterCredentials)

可选

The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.

string

必需

A system-unique id for the created resource

🟠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`)

Get eligible remote clusters

Get Deployment