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.
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. Available values: ON, OFF |
| IsInMaintainPeriod | No | String | yes: Modify within the Ops time window. no: Immediately execute (default value) |
| Parameter Name | Type | Description |
|---|---|---|
| ClusterTaskIds | Array of ClusterTaskId | Cluster task ID list |
| 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. |
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"
}{
"Response": {
"ClusterTaskIds": [
{
"ClusterId": "cynosdbmysql-jl17y89v",
"TaskId": "176551"
},
{
"ClusterId": "cynosdbmysql-2d9pq38h",
"TaskId": "176552"
}
],
"RequestId": "48b7cd8a-f6dd-4e47-a78a-ssfff"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 the process. Please retry later. If the issue continues, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.InternalHttpServerError | http request execution error. |
| InternalError.SystemError | Internal system error. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| OperationDenied.ServerlessClusterStatusDenied | Operation not allowed in the current status of the serverless cluster. |
| OperationDenied.ServerlessInstanceStatusDenied | Operation not allowed in the current status of the serverless instance. |
| OperationDenied.TaskConflictError | Task conflict check failed. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
フィードバック