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

Habilita o deshabilita la función de cifrado SSL (Secure Sockets Layer) para un clúster de PolarDB, o actualiza el certificado de CA de un clúster de PolarDB.

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:ModifyDBClusterSSL

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.	pc-************
SSLEnabled	string	No	El estado de SSL que se debe configurar. Valores válidos: Disable: Deshabilita el cifrado SSL. Enable: Habilita el cifrado SSL. Update: Actualiza el certificado de CA. Nota Después de habilitar el cifrado SSL o actualizar el certificado de CA, debe descargar y configurar el certificado. Para obtener más información, consulte Configuración del cifrado SSL.	Enable
DBEndpointId	string	No	El ID del endpoint. Nota Si el clúster es un clúster de PolarDB for MySQL, este parámetro es obligatorio. Si el clúster es un clúster de PolarDB for PostgreSQL o un clúster de PolarDB for PostgreSQL (compatible con Oracle), no necesita especificar este parámetro. El cifrado SSL está habilitado de forma predeterminada para todos los endpoints. Puede llamar a la operación DescribeDBClusterSSL para consultar los detalles del endpoint.	pe-******************
NetType	string	No	El tipo de red del endpoint. El valor debe ser igual al tipo de red del endpoint especificado por DBEndpointId. Valores válidos: Public: Red pública Private: Red privada Inner: Red privada (red clásica) Nota Si el clúster es un clúster de PolarDB for MySQL, este parámetro es obligatorio. Si el clúster es un clúster de PolarDB for PostgreSQL o un clúster de PolarDB for PostgreSQL (compatible con Oracle), no necesita especificar este parámetro. El cifrado SSL está habilitado de forma predeterminada para todos los endpoints.	Public
SSLAutoRotate	string	No	Especifica si se debe habilitar la rotación automática de certificados SSL. Valores válidos: Enable: Habilitado. Disable: Deshabilitado.	Enable
CertValidDays	string	No	El periodo de validez del certificado SSL. Unidad: días. Valores válidos: 365 y 1095.	1095
PfsInstanceId	string	No	El ID de la instancia PFS.	pfs-xxx
ConnectionString	string	No	La cadena de conexión.	xxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	A94B1755-6D8B-4E27-BF3C-8562BC******

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "A94B1755-6D8B-4E27-BF3C-8562BC******"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	EngineMigration.ActionDisabled	Specified action is disabled while custins is in engine migration.
400	InvalidDBEndpointId.Malformed	The specified parameter DBEndpointId is not valid.
400	InvalidSSLAutoRotate.Malformed	The specified SSLAutoRotate is not valid.
400	InvalidNetType.Malformed	The specified parameter NetType is not valid.
400	InvalidConnectionString.Malformed	The specified parameter ConnectionString is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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.