Help Center/ Cloud Search Service/ API Reference (Kuala Lumpur Region)/ API V1/ Cluster Management/ Retrying or Terminating a Failed Upgrade or AZ Switchover Task
Updated on 2026-09-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Retrying or Terminating a Failed Upgrade or AZ Switchover Task

Function

This API is used to retry the upgrade or AZ change of an Elasticsearch or OpenSearch cluster. The upgrade or AZ change may take a long time and may fail due to network issues. You can use this API to retry or stop a failed upgrade task.

Constraints

  • To call this API, the task status must be failed.

  • During a cross-version upgrade, if Task Status is Failed, you can terminate the upgrade task only if all nodes have not been upgraded.

  • During an AZ switchover, if Task Status is Failed, you can terminate the upgrade task only if none of the nodes has been switched.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints

N/A

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

ID of the cluster for which you want to retry the failed task. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

N/A

Range

The value is a UUID containing 36 characters.

Default Value

N/A

action_id

Yes

String

Definition

ID of the task to be retried. For details, see Obtaining Details About a Cluster Upgrade or AZ Switchover.

Constraints

ID of the failed task, in UUID format.

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

retry_mode

No

String

Definition

Select a retry mode. If this parameter is set, the upgrade task is terminated. If this parameter is not set, the upgrade task is retried.

Constraints

Only abort is currently supported.

Range

abort: Terminate the upgrade task.

Default Value

If not set, the default is to retry the upgrade task.

Request Parameters

None

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

  • Example request for retrying a cluster upgrade or AZ switchover task.

    PUT https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry

  • Example request for terminating a cluster upgrade or AZ switchover task.

    PUT https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

The client should not repeat the request without modifications.

403

Request rejected.

The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

Parent topic: Cluster Management