調用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 PostgreSQL版（兼容Oracle），該參數必填。
  • 若目標集群為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分鐘。例如當設置PlannedStartTime為2021-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。

訪問錯誤中心查看更多錯誤碼。