Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Retrying or Terminating a Failed Upgrade or AZ Switchover Task

Updated on 2025-11-28 GMT+08:00

View PDF

Retrying or Terminating a Failed Upgrade or AZ Switchover Task

Function

The upgrade or AZ change may take a long time and may fail due to network issues. This API can be used to retry or stop a failed 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 Value range: Project ID of the account. 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 Value range: Cluster ID. Default value: N/A
action_id	Yes	String	Definition: ID of the task to be retried. For details about how to obtain the cluster ID, see Obtaining Details About a Cluster Upgrade or AZ Switchover. Constraints: ID of a failed task. Value range: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
retry_mode	No	String	Definition: Select a retry mode. When this parameter is set, the upgrade task will be terminated. When it is not, the upgrade task will be retried. Constraints: Currently, its value can only be abort. Value range: abort: Terminates the upgrade task. Default value: N/A

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.

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.