ModifyDBCluster - PolarDB - Centro de documentación de Alibaba Cloud

Modifica la configuración de las características de un clúster de PolarDB for MySQL.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:ModifyDBCluster

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster. Nota Puede llamar a la operación DescribeDBClusters para consultar todos los clústeres en la región especificada, incluidos los ID de los clústeres.	pc-*************
StandbyHAMode	string	No	El modo de conmutación automática entre zonas del clúster. Valores válidos: ON: Habilita la conmutación automática entre zonas. OFF: Deshabilita la conmutación automática entre zonas.	ON
DataSyncMode	string	No	El modo de replicación de datos entre zonas del clúster. Valores válidos: AsyncSync: Asíncrono. SemiSync: Semisíncrono.	AsynSync
FaultSimulateMode	string	No	La dimensión del simulacro de fallas para el clúster. Valores válidos: `0` o `FaultInjection`: Simulacro de fallas en la dimensión de zona primaria. `1`: Simulacro de fallas en la dimensión de nodo. Nota En el escenario de simulacro de fallas en la dimensión de zona primaria, todos los nodos de computación en la zona primaria dejan de estar disponibles, y la conmutación por desastre en este escenario conlleva pérdida de datos. En el escenario de simulacro de fallas en la dimensión de nodo, solo se puede simular una falla en un único nodo de computación. Pase el nombre del nodo de computación deseado a través de `DBNodeCrashList`. Valores válidos: 0 : Simulacro de fallas en la dimensión de zona primaria. 1 : Simulacro de fallas en la dimensión de nodo. FaultInjectToDbNode : Simulacro de fallas en la dimensión de nodo. FaultInjectToPrimaryAz : Simulacro de fallas en la dimensión de zona primaria. FaultInjection : Simulacro de fallas en la dimensión de zona primaria.	0
StorageAutoScale	string	No	Especifica si se debe habilitar el escalado automático de almacenamiento para un clúster de Standard Edition. Valores válidos: Enable: Habilita el escalado automático de almacenamiento. Disable: Deshabilita el escalado automático de almacenamiento. Valores válidos: Enable : Habilita el escalado automático de almacenamiento. Disable : Deshabilita el escalado automático de almacenamiento.	Enable
CompressStorage	string	No	Habilita la compresión de almacenamiento. Establezca el valor en ON.	ON
StorageUpperBound	integer	No	El límite superior para el escalado automático de almacenamiento de un clúster de Standard Edition. Unidad: GB. Nota El valor máximo es 32,000.	800
DBNodeCrashList	string	No	La lista de nombres de instancias de nodos para el simulacro. Nota Los simulacros en la dimensión de nodo admiten solo un único nodo. Para los simulacros en la dimensión de zona, puede omitir este parámetro o pasar todos los nodos.	pi-rwxxx
FaultInjectionType	string	No	El método de inyección de fallas. Valores válidos: 0: Inyección de fallas de instancia basada en `Crash SQL`. Valores válidos: CrashSQLInjection : CrashSQLInjection.	0
ImciAutoIndex	string	No	La función de aceleración de consultas automática basada en IMCI. Valores válidos: `ON`: Habilitada. `OFF`: Deshabilitada. Nota Solo se admiten los clústeres de PolarDB for MySQL. Para los límites de versión del clúster, consulte Aceleración automática de consultas basada en IMCI (AutoIndex). Valores válidos: OFF : OFF. ON : ON	OFF
TableMeta	string	No	La cadena JSON de la información de la base de datos y las tablas de destino que se van a restaurar. Los valores de la información de la base de datos y las tablas son todos de tipo cadena. Ejemplo: `[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]`. Nota Puede llamar a la operación DescribeMetaList para ver los detalles de los nombres de las bases de datos y tablas que admiten restauración, y completar la información de las bases de datos y tablas admitidas en las posiciones correspondientes en el ejemplo anterior.	[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]
ModifyRowCompression	string	No	Modifica la configuración de compresión de filas.	OFF
ConnectionResourceQuota	integer	No	La cuota de recursos de conexión del clúster de AgenticDB.

Para los parámetros StandbyHAMode, DataSyncMode, FaultSimulateMode y StorageAutoScale, solo puede establecer un parámetro por llamada. Por ejemplo, si establece el parámetro StandbyHAMode, no puede establecer otros parámetros de solicitud al mismo tiempo.

Nota

Cuando el parámetro StorageAutoScale se establece en Enable, también debe establecer el parámetro StorageUpperBound para especificar el límite superior para el escalado automático de almacenamiento del clúster.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	CD3FA5F3-FAF3-44CA-AFFF-BAF869******
DBClusterId	string	El ID del clúster.	pc-*************
OrderId	string	El ID de la orden generada.	2148126708*****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******",
  "DBClusterId": "pc-*************",
  "OrderId": "2148126708*****"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	OperationDenied.CreateDBNodesWithStrictConsistencyOn	3AZ cluster does not allow create db nodes.	No se permite agregar nodos a un clúster de tres zonas.
400	InvalidDBProxyClusterClass.Malformed	The specified parameter DBProxyClusterClass is not valid.	El parámetro DBProxyClusterClass especificado no es válido.
400	InvalidDBNodeNum.Malformed	The number of parameter DBNode.N is not valid.	El número de parámetros DBNode no es válido.
400	OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn	3AZ cluster does not allow modify db node class.	No se permite cambiar las especificaciones de los nodos de registro en un clúster de tres zonas.
400	InvalidDowngradeDBNodeClass.Limit	The specified Downgrade DBNodeClass is limit on the MaxDiskSize.	La reducción de DBNodeClass está restringida por MaxDiskSize.
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.	El motor especificado no admite esta función.
400	OperationDenied.ModifyProxyWithStrictConsistencyOn	3AZ cluster does not allow modify proxy.	No se permite cambiar el proxy de base de datos en un clúster de tres zonas.
400	StandbyClusterTurnOn	The specified dbCluster already turn on hot standby cluster.	El dbCluster especificado ya tiene el clúster de espera activa habilitado.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	El procesamiento de la solicitud falló debido a un error desconocido, una excepción o una falla.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	El tipo de instancia de base de datos actual no admite esta operación.
403	IncorrectDBInstance	Current DB instance does not support this operation.	La instancia de base de datos actual no admite esta operación.
403	OperationDenied.LockMode	The operation is not permitted due to lock of cluster.	La operación falló porque la instancia está en el estado Locked y no admite esta operación.
403	OperationDenied.DBClusterStatus	The operation is not permitted due to status of cluster.	No se permite la operación en el estado actual del clúster PolarDB.
403	OperationDenied.TempUpgradeDuring	This operation is not allowed during the temporary upgrade of the cluster.	No se permite esta operación durante una actualización temporal del clúster.
403	InvalidParam.PgDBNodeSpec	The specification PGO of DB nodes is incorrect.	La especificación PGO del nodo de base de datos es incorrecta.
403	InvalidParam.NoChange	No change found	No se encontraron cambios.
403	OperationDenied.DBNodeClass	The target DB node class is invalid for SQL acceleration.	La clase de nodo de base de datos de destino no es válida para la aceleración SQL.
403	OperationDenied.ReaderNum	The target reader node number is invalid for SQL acceleration.	El ID del nodo lector de destino no es válido para la aceleración de SQL.
403	InvalidParam.DBNodeNum	The number of DB nodes is incorrect.	El número de nodos de base de datos es incorrecto.
403	OperationDenied.DBNodeRole	The operation is not permitted due to the role of node.	No se permite la operación debido al rol del nodo.
403	OperationDenied.DeleteNode	The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.	Los clústeres de la edición SENormal no permiten la eliminación simultánea de nodos de solo lectura y nodos en espera.
403	OperationDenied.EndpointDBNodeNumber	The operation is not permitted due to node number for Endpoint.	No se permite la operación para este endpoint.
403	OperationDenied.StandbyEqualSpec	The spec of standby must be equal to rw	La especificación de nodo en espera debe ser RW.
403	OperationDenied.DeleteDBNodeNumber	The operation is not permitted due to the node number to delete.	No se permite eliminar el nodo.
403	OperationDenied.DbVersion	The operation is not permitted due to DbVersion.	No se permite la operación debido a la versión del motor de base de datos.
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.	El clúster no admite esta serie de producto.
403	OperationDenied.clusterSingleNodeLimit	Single-node instances are not supported and need to be upgraded to cluster version	No se admiten instancias de un solo nodo. Actualice la instancia a la edición Cluster Edition.
403	InvalidParam.CRACParamNodeNum	The CRAC nodes cannot exceed 8.	El número de nodos CRAC no puede superar los 8.
403	InvalidParam.ECSESSDSTANDARDParamNodeNum	The ECSESSDSTANDARD nodes cannot exceed 8.	El número de nodos ECESSDSTANDARD no puede superar los 8.
404	InvalidParam	Invalid Parameter.
404	InvalidEditType	Wrong upgrade type.	El tipo de actualización no es válido.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.