ModifyDBInstanceSSL - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Descripción de la operación

Antes de llamar a la operación ModifyDBInstanceSSL, asegúrese de que la instancia cumpla con los siguientes requisitos:

La instancia se encuentra en estado de ejecución.
La instancia es una instancia de conjunto de réplicas o una instancia de clúster fragmentado.
- La instancia de conjunto de réplicas tiene la versión 3.4 o posterior.
- La instancia de clúster fragmentado utiliza unidades de estado sólido mejoradas (ESSD).

Nota

Habilitar, actualizar o deshabilitar SSL reinicia la instancia. Se recomienda realizar estas operaciones fuera del horario de máxima actividad.

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

dds:ModifyDBInstanceSSL

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-bp2235****
SSLAction	string	Sí	La operación que se debe realizar en la función SSL. Valores válidos: Open: Habilita el cifrado SSL. Close: Deshabilita el cifrado SSL. Update: Actualiza el certificado SSL.	Open
SwitchMode	string	No	El momento para modificar la configuración SSL de la instancia de MongoDB. Valores válidos: 0: Modificar inmediatamente. 1: Modificar dentro de la ventana de mantenimiento.	0
ForceEncryption	string	No	Especifica si se debe habilitar forzosamente el cifrado SSL para las conexiones. Valores válidos: 1: Habilitar forzosamente el cifrado SSL. 0: No habilitar forzosamente el cifrado SSL. Nota El cifrado SSL forzado solo es compatible con instancias de MongoDB 7.0 y 8.0 que utilizan discos en la nube y cumplen con los siguientes requisitos de versión secundaria del motor: Para la versión 7.0, la versión secundaria del motor debe ser la 8.0.13 o posterior. Para la versión 8.0, la versión secundaria del motor debe ser la 9.0.5 o posterior. Aviso Después de habilitar el cifrado SSL forzado, solo se permiten conexiones SSL a la instancia. Valores válidos: 0 : 0 1 : 1	0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	6D806B11-078F-4154-BF9F-844F56D08964

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParam	Specified parameters is not valid.
400	SSLAlreadyEnabled	SSL have already been enabled.
400	SSLAlreadyDisabled	SSL have already been disabled.
403	SSLNotEnabled	SSL not enabled.
403	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The current database instance locking mode does not support this operation.
404	EnabledSSLNotSupport	Specified region does not support enable ssl.

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.