Shuts down Deployment

开发环境

http://127.0.0.1

POST

/deployments/{deployment_id}/_shutdown

Deployments

Shuts down all resources in a Deployment.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://127.0.0.1/deployments//_shutdown' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

{
    "id": "string",
    "orphaned": {
        "appsearch": [
            "string"
        ],
        "elasticsearch": [
            {
                "dependents": [
                    {
                        "kind": "string",
                        "id": "string"
                    }
                ],
                "id": "string"
            }
        ],
        "enterprise_search": [
            "string"
        ],
        "kibana": [
            "string"
        ],
        "apm": [
            "string"
        ]
    },
    "name": "string"
}

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment

Query 参数

hide

可选

Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.

skip_snapshot

可选

Whether or not to skip snapshots before shutting down the resources

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200The request was valid and the resources of the deployment were shutdown.

application/json

Body

A response returned from the Deployment shutdown endpoint

string

必需

The id of the deployment

orphaned

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

name

string

必需

The name of the deployment

🟠400Parameter is restricted and can only be set by a Platform administrator. (code: `deployments.restricted_parameter`)

🟠401You are not authorized to perform this action.

🟠404The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)

Restart Deployment Stateless Resource

Migrate Elasticsearch resource to use SLM