Shutdown Deployment Stateless Resource

开发环境

http://127.0.0.1

POST

/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown

Deployments

Shut down Stateless Resource belonging to a given Deployment.
Kibana cannot be shut down on Elasticsearch Service as it is required for Elasticsearch administrative functions, such as Snapshot Lifecycle Management and version upgrades.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - 示例 1

{
    "warnings": [
        {
            "message": "string",
            "code": "string"
        }
    ]
}

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment.

stateless_resource_kind

必需

The kind of stateless resource

ref_id

必需

User-specified RefId for the Resource.

Query 参数

hide

可选

Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.

skip_snapshot

可选

If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢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

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

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

Migrate Elasticsearch resource to use ILM

Get Deployment APM Resource Info