Updated on 2025-08-06 GMT+08:00

Canceling Read-only Status of a Cluster

Function

This API is used to cancel the read-only status on the management console. When a cluster is in the read-only state, you cannot perform any database operations. The read-only state may be triggered because the disk usage is too high. You need to clear the cluster data or scale out the cluster.

Constraints

The read-only status can be canceled for clusters of version 1.7.2 or later.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cancel-readonly

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

The read-only state is removed successfully.

None

Example Requests

Cancel read-only status.

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/cancel-readonly

Example Responses

Status code: 200

The read-only state is removed successfully.

{ }

Status Codes

Status Code

Description

200

The read-only state is removed successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.