ModifyDBClusterParameters - 修改PolarDB叢集的參數 -

介面說明

PolarDB 新增參數模板功能，您可以使用參數模板功能，對參數進行集中管理，並快速應用至叢集。更多詳情，請參見使用參數模板。

說明

當前僅 PolarDB MySQL 版支援參數模板功能。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyDBClusterParameters

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。	pc-**************
Parameters	string	否	參數及其值的 JSON 串，參數的值都是字串類型，例如`{"wait_timeout":"86","innodb_old_blocks_time":"10"}`。說明您可以通過介面 DescribeDBClusterParameters 查看 PolarDB 叢集的參數。若目的地組群為 PolarDB PostgreSQL 版或 PolarDB PostgreSQL 版（相容 Oracle），該參數必填。若目的地組群為 PolarDB MySQL 版，您需在該參數或`ParameterGroupId`參數中選擇一個傳入。	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	否	參數模板 ID。說明您可以通過 DescribeParameterGroups 介面查看參數模板 ID。您需在該參數或`Parameters`參數中選擇一個傳入。僅 PolarDB MySQL 版支援該參數。	pcpg-**************
PlannedStartTime	string	否	開始執行定時（即在目標時間段內執行）任務的最早時間。格式為`YYYY-MM-DDThh:mm:ssZ`（UTC）。說明開始時間的取值範圍為未來 24 小時內的任意時間點。例如目前時間為`2021-01-14T09:00:00Z`，此處允許填入的開始時間範圍為`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。若該參數留空，預設立即執行任務。	2022-04-28T14:00:00Z
PlannedEndTime	string	否	開始執行目標定時任務的最晚時間。格式為`YYYY-MM-DDThh:mm:ssZ`（UTC）。說明最晚時間需晚於開始時間的 30 分鐘或以上。若設定了`PlannedStartTime`但未指定該參數，執行目標任務的最晚時間預設為`開始時間+30 分鐘`。例如當設定`PlannedStartTime`為`2021-01-14T09:00:00Z`且該參數留空時，目標任務最晚將於`2021-01-14T09:30:00Z`開始執行。	2022-04-28T14:30:00Z
FromTimeService	boolean	否	立即執行或定時執行修改參數並重啟叢集。取值： false（預設值）：定時執行 true：立即執行	false
ClearBinlog	boolean	否

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	C5D526E5-91B5-48B8-B980-FE07FF******

樣本

正常返回樣本

JSON格式

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

異常返回樣本

JSON格式

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameters.Format	Specified parameters is not valid.	指定的參數無效。
400	MinorVersionNotSupport	Custins minor version does not support current action.	當前小版本不支援該功能，請先升級到最新版本.
400	ParamDynamicException	Conflicting parameters: %s	請檢查執行個體核心參數及當前修改參數是否存在提示相同的情況 %s
400	InvalidParameters.Malformed	The Specified parameters is not valid.	指定的參數無效
400	InvalidParameter.Malformed	Choose one of parameters and ParamGroupId.	從parameters中選擇一個ParamGroupId。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的 DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的參數DBClusterId無效

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

變更歷史

更多資訊，參考變更詳情。