修改PolarDB MySQL集群的功能配置。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
polardb:ModifyDBCluster | update |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 說明
您可以調用 DescribeDBClusters 接口查看目標地域下所有的集群信息,包括集群 ID。
| pc-************* |
StandbyHAMode | string | 否 | 集群的跨可用區(qū)自動切換模式,取值范圍如下:
| ON |
DataSyncMode | string | 否 | 集群的跨可用區(qū)數(shù)據(jù)復制方式,取值范圍如下:
| AsynSync |
FaultSimulateMode | string | 否 | 集群的故障演練維度。取值范圍如下:
說明
DBNodeCrashList 傳入期望計算節(jié)點名。 | 0 |
StorageAutoScale | string | 否 | 標準版集群是否開啟存儲自動擴容。取值范圍如下:
| Enable |
CompressStorage | string | 否 | 開啟存儲壓縮。取值為 ON。 | ON |
StorageUpperBound | long | 否 | 標準版集群存儲自動擴容上限,單位:GB。 說明
取值最大為 32000。
| 800 |
DBNodeCrashList | string | 否 | 演練節(jié)點實例名列表。 說明
節(jié)點維度的演練只支持單個節(jié)點,可用區(qū)維度的演練可不傳該參數(shù),或傳入所有節(jié)點。
| pi-rwxxx |
FaultInjectionType | string | 否 | 故障注入方式。取值范圍如下:
枚舉值:
| 0 |
ImciAutoIndex | string | 否 | OFF |
對于參數(shù) StandbyHAMode、DataSyncMode、FaultSimulateMode 和 StorageAutoScale,每次調用只能設置一個。如設置了 StandbyHAMode 參數(shù)的值后,不支持再同時設置其它的請求參數(shù)的值。
說明
當參數(shù) StorageAutoScale 的值設置為 Enable 后,還需要設置集群存儲自動擴容上限 StorageUpperBound 參數(shù)的值。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******",
"DBClusterId": "pc-*************",
"OrderId": "2148126708*****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | OperationDenied.CreateDBNodesWithStrictConsistencyOn | 3AZ cluster does not allow create db nodes. | 3AZ 集群不允許增加節(jié)點。 |
400 | InvalidDBProxyClusterClass.Malformed | The specified parameter DBProxyClusterClass is not valid. | 指定的參數(shù)DBProxyClusterClass無效。 |
400 | InvalidDBNodeNum.Malformed | The number of parameter DBNode.N is not valid. | 參數(shù)DBNode的數(shù)量無效 |
400 | OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn | 3AZ cluster does not allow modify db node class. | 3AZ 集群不允許變更 Logger 節(jié)點規(guī)格。 |
400 | InvalidDowngradeDBNodeClass.Limit | The specified Downgrade DBNodeClass is limit on the MaxDiskSize. | DBNodeClass降配被MaxDiskSize的限制。 |
400 | InvalidEngine.Unsupported | The specified Engine does not support this feature. | 指定的引擎不支持此功能 |
400 | OperationDenied.ModifyProxyWithStrictConsistencyOn | 3AZ cluster does not allow modify proxy. | 3AZ 集群不允許變更數(shù)據(jù)庫代理。 |
400 | StandbyClusterTurnOn | The specified dbCluster already turn on hot standby cluster. | 指定的dbCluster已打開熱備集群。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 當前數(shù)據(jù)庫實例類型不支持此操作 |
403 | IncorrectDBInstance | Current DB instance does not support this operation. | 當前數(shù)據(jù)庫實例不支持此操作 |
403 | OperationDenied.LockMode | The operation is not permitted due to lock of cluster. | PolarDB集群當前鎖定狀態(tài)下不允許執(zhí)行該操作。 |
403 | OperationDenied.DBClusterStatus | The operation is not permitted due to status of cluster. | PolarDB集群當前狀態(tài)下不允許執(zhí)行該操作。 |
403 | OperationDenied.TempUpgradeDuring | This operation is not allowed during the temporary upgrade of the cluster. | 在集群的臨時升級過程中,不允許執(zhí)行此操作。 |
403 | InvalidParam.PgDBNodeSpec | The specification PGO of DB nodes is incorrect. | DB節(jié)點的規(guī)范PGO不正確。 |
403 | InvalidParam.NoChange | No change found | 未找到更改 |
403 | OperationDenied.DBNodeClass | The target DB node class is invalid for SQL acceleration. | 目標DB節(jié)點類對于SQL加速無效。 |
403 | OperationDenied.ReaderNum | The target reader node number is invalid for SQL acceleration. | 目標讀取器節(jié)點號對于SQL加速無效。 |
403 | InvalidParam.DBNodeNum | The number of DB nodes is incorrect. | 數(shù)據(jù)庫節(jié)點的數(shù)量不正確。 |
403 | OperationDenied.DBNodeRole | The operation is not permitted due to the role of node. | 由于節(jié)點的角色,不允許該操作 |
403 | OperationDenied.DeleteNode | The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time. | senormal版本集群不允許同時刪除ro節(jié)點和備用節(jié)點。 |
403 | OperationDenied.EndpointDBNodeNumber | The operation is not permitted due to node number for Endpoint. | 該Endpoint不允許執(zhí)行該操作。 |
403 | OperationDenied.StandbyEqualSpec | The spec of standby must be equal to rw | 備用的規(guī)格必須為rw |
403 | OperationDenied.DeleteDBNodeNumber | The operation is not permitted due to the node number to delete. | 該節(jié)點不允許被刪除。 |
403 | OperationDenied.DbVersion | The operation is not permitted due to DbVersion. | 由于DB版本問題,不允許執(zhí)行此操作。 |
403 | OperationDenied.ClusterCategory | The operation is not permitted due to cluster category. | 該集群不支持此產(chǎn)品系列。 |
403 | OperationDenied.clusterSingleNodeLimit | Single-node instances are not supported and need to be upgraded to cluster version | 不支持單節(jié)點實例,需要將其升級到集群版本。 |
403 | InvalidParam.CRACParamNodeNum | The CRAC nodes cannot exceed 8. | CRAC節(jié)點不能超過8個。 |
403 | InvalidParam.ECSESSDSTANDARDParamNodeNum | The ECSESSDSTANDARD nodes cannot exceed 8. | ECESSDSTANDARD節(jié)點不能超過8個。 |
404 | InvalidParam | Invalid Parameter. | - |
404 | InvalidEditType | Wrong upgrade type. | 升級類型錯誤。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 由于某些未知錯誤、異常或失敗,請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-06-06 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-12-26 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-09-19 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-08-03 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-07-19 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |