tencent cloud

APIs

ModifyClusterParam

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-23 11:25:12

1. API Description

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

This API is used to modify cluster parameters.

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. 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.
ClusterId Yes String Cluster ID
ParamList.N Yes Array of ParamItem List of parameters to modify. Each element is a combination of ParamName, CurrentValue, and OldValue. ParamName is the parameter name, CurrentValue is the current value, and OldValue is the old value and is not validated.
IsInMaintainPeriod No String Execute during the maintenance period - yes, immediate execution - no

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async request Id, used for querying results
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 Modifying Cluster Parameters

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.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

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

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック