修改PolarDB集群的參數或將已有的參數模板應用到目標集群上。
接口說明
PolarDB 新增參數模板功能,您可以使用參數模板功能,對參數進行集中管理,并快速應用至集群。更多詳情,請參見使用參數模板。
說明
當前僅 PolarDB MySQL 版支持參數模板功能。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
polardb:ModifyDBClusterParameters | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 說明
您可以調用 DescribeDBClusters 接口查看目標地域下所有的集群信息,包括集群 ID。
| pc-************** |
Parameters | string | 否 | 參數及其值的 JSON 串,參數的值都是字符串類型,例如 說明
ParameterGroupId 參數中選擇一個傳入。 | {"wait_timeout":"86","innodb_old_blocks_time":"10"} |
ParameterGroupId | string | 否 | 參數模板 ID。 說明
Parameters 參數中選擇一個傳入。 | pcpg-************** |
PlannedStartTime | string | 否 | 開始執行定時(即在目標時間段內執行)任務的最早時間。格式為 說明
2021-01-14T09:00:00Z ,此處允許填入的開始時間范圍為2021-01-14T09:00:00Z ~2021-01-15T09:00:00Z 。 | 2022-04-28T14:00:00Z |
PlannedEndTime | string | 否 | 開始執行目標定時任務的最晚時間。格式為 說明
PlannedStartTime 但未指定該參數,執行目標任務的最晚時間默認為開始時間+30 分鐘 。例如當設置PlannedStartTime 為2021-01-14T09:00:00Z 且該參數留空時,目標任務最晚將于2021-01-14T09:30:00Z 開始執行。 | 2022-04-28T14:30:00Z |
FromTimeService | boolean | 否 | 立即執行或定時執行修改參數并重啟集群。取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "C5D526E5-91B5-48B8-B980-FE07FF******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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. | 當前小版本不支持該功能,請先升級到最新版本. |
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無效 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
2023-06-13 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
2023-06-13 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
2022-11-24 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
2021-03-08 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
2021-03-08 | OpenAPI 入參發生變更 | 看變更集 | ||||||||
|