ModifyClusterReadOnly

Last updated: 2025-11-13 20:51:04

ModifyClusterReadOnly

Last updated: 2025-11-13 20:51:04

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to modify the read-only switch of a cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyClusterReadOnly.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterIds.N	Yes	Array of String	List of cluster IDs
ReadOnlyOperation	Yes	String	Cluster read-only switch, valid values: ON, OFF.
IsInMaintainPeriod	No	String	Valid values: `yes` (modify in maintenance window), `no` (execute now by default).

3. Output Parameters

Parameter Name	Type	Description
ClusterTaskIds	Array of ClusterTaskId	List of cluster task ids.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify the Cluster Read-Only Switch

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyClusterReadOnly
<Common request parameters>

{
    "ClusterIds": [
        "cynosdbmysql-jl17y89v",
        "cynosdbmysql-2d9pq38h"
    ],
    "ReadOnlyOperation": "ON",
    "IsInMaintainPeriod": "no"
}

Output Example

{
    "Response": {
        "ClusterTaskIds": [
            {
                "ClusterId": "cynosdbmysql-jl17y89v",
                "TaskId": "176551"
            },
            {
                "ClusterId": "cynosdbmysql-2d9pq38h",
                "TaskId": "176552"
            }
        ],
        "RequestId": "48b7cd8a-f6dd-4e47-a78a-ssfff"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.InternalHttpServerError	An exception occurred while executing the HTTP request.
InternalError.SystemError	Internal system error.
InternalError.UnknownError	Unknown internal error.
InvalidParameterValue.InstanceNotFound	The instance does not exist.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
OperationDenied.ServerlessClusterStatusDenied	For the serverless cluster in this status, the operation is not allowed.
OperationDenied.ServerlessInstanceStatusDenied	For the serverless instance in this status, the operation is not allowed.
OperationDenied.TaskConflictError	The task conflict check failed.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud