Cancel resource pending plan

开发环境

http://127.0.0.1

DELETE

/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending

Deployments

Cancels the pending plan of a Resource belonging to a given Deployment.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'http://127.0.0.1/deployments////plan/pending' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

{
    "kind": "string",
    "id": "string",
    "ref_id": "string"
}

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment

resource_kind

必需

The kind of resource

ref_id

必需

User-specified RefId for the Resource

Query 参数

force_delete

可选

When true, deletes the pending plan instead of attempting a graceful cancellation. The default is false.

ignore_missing

可选

When true, returns successfully, even when plans are missing. The default is false.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200Standard Deployment Resource Crud Response

application/json

Body

A response returned from the Deployment Resource endpoints

kind

string

必需

The kind of the stateless resource

string

必需

The id of the deployment

ref_id

string

必需

The reference id of the resource

🟠400The Resource does not have a pending plan. (code: `deployments.resource_does_not_have_a_pending_plan`)

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

🟠449Elevated permissions are required. (code: `root.unauthorized.rbac.elevated_permissions_required`)

🔴500We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)

Stop maintenance mode

Get Deployment App Search Resource Info