调用ModifyDBClusterParameters接口修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。

PolarDB新增参数模板功能,您可以使用参数模板功能,对参数进行集中管理,并快速应用至集群。更多详情,请参见使用参数模板

说明 当前仅PolarDB MySQL集群支持参数模板功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBClusterParameters

系统规定参数。取值:ModifyDBClusterParameters

DBClusterId String pc-**************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息,包括集群ID。
Parameters String {"wait_timeout":"86","innodb_old_blocks_time":"10"}

参数及其值的JSON串,参数的值都是字符串类型,例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}

说明
  • 您可以通过接口DescribeDBClusterParameters查看PolarDB集群的参数。
  • 若目标集群为PolarDB PostgreSQL引擎或PolarDB O引擎,该参数必填。
  • 若目标集群为PolarDB MySQL引擎,您需在该参数或ParameterGroupId参数中选择一个传入。
ParameterGroupId String pcpg-**************

参数模板ID。

说明
  • 您可以通过DescribeParameterGroups接口查看参数模板ID。
  • 您需在该参数或Parameters参数中选择一个传入。
  • 仅PolarDB MySQL集群支持该参数。
PlannedStartTime String 2022-04-28T14:00:00Z

开始执行定时(即在目标时间段内执行)任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

说明
  • 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z,此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z
  • 若该参数留空,默认立即执行任务。
PlannedEndTime String 2022-04-28T14:30:00Z

开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

说明
  • 最晚时间需晚于开始时间的30分钟或以上。
  • 若设置了PlannedStartTime但未指定该参数,执行目标任务的最晚时间默认为开始时间+30分钟。例如当设置PlannedStartTime2021-01-14T09:00:00Z且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z开始执行。
FromTimeService Boolean false

立即执行或定时执行修改参数并重启集群。取值:

  • false(默认值):定时执行
  • true:立即执行

返回数据

名称 类型 示例值 描述
RequestId String C5D526E5-91B5-48B8-B980-FE07FF******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterParameters
&DBClusterId=pc-**************
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBClusterParametersResponse>
<RequestId>C5D526E5-91B5-48B8-B980-FE07FF******</RequestId>
</ModifyDBClusterParametersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C5D526E5-91B5-48B8-B980-FE07FF******"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameters.Format Specified parameters is not valid. 指定的参数无效。
400 InvalidParameters.Format The specified parameters are invalid. 参数不正确。
400 MinorVersionNotSupport Custins minor version does not support current action. 当前小版本不支持该功能,请先升级到最新版本.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的 DBClusterId。

访问错误中心查看更多错误码。