ModifyClusterParam

Download PDF

ModifyClusterParam

最后更新时间：2023-08-23 14:22:55

下载PDF

1. API Description

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

This API is used to modify the parameters 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: ModifyClusterParam.
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.
ClusterId	Yes	String	Cluster ID
ParamList.N	Yes	Array of ParamItem	List of the parameters to be modified. Each element in the list is a combination of `ParamName`, `CurrentValue`, and `OldValue`. `ParamName` is the parameter name; `CurrentValue` is the current value; `OldValue` is the old value that doesn’t need to be verified.
IsInMaintainPeriod	No	String	Valid values: `yes` (execute during maintenance time), `no` (execute now)

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	Async request ID used to query the result
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the parameters of a cluster

Input Example

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

{
    "ClusterId": "cynosdbmysql-ins-jhi2gdi0",
    "ParamList": [
        {
            "CurrentValue": "59",
            "OldValue": "60",
            "ParamName": "authentication_timeout"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "164063",
        "AsyncRequestId": "56317d06-8078-4e5c-b675-9e048995c820"
    }
}

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.TaskConflictError	The task conflict check failed.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

tencent cloud

Recent Pages

ModifyClusterParam

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying the parameters of a cluster

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

ModifyClusterParam

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying the parameters of a cluster

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？