All Products
Search

This Product

    PolarDB:ModifyDBClusterSSL

    Document Center

    PolarDB:ModifyDBClusterSSL

    Last Updated:Jul 03, 2026

    Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    pc-************
    SSLEnabled

    string

    No

    The SSL status. Valid values:

    • Disable: shutdown SSL encryption.

    • Enable: enables SSL encryption.

    • Update: updates the CA certificate.

    Note

    After you enable SSL encryption or update the CA certificate, you must download and configure the certificate. For details, see Settings for SSL encryption.

    Enable
    DBEndpointId

    string

    No

    The endpoint ID.

    Note

    • If the cluster is a PolarDB for MySQL cluster, this parameter is required.

    • If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.

    • You can call the DescribeDBClusterSSL operation to query endpoint details.

    pe-******************
    NetType

    string

    No

    The network type of the endpoint. The value must be the same as the network type of the endpoint specified by DBEndpointId. Valid values:

    • Public: public network

    • Private: private network

    • Inner: private network (classic network)

    Note

    • If the cluster is a PolarDB for MySQL cluster, this parameter is required.

    • If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.

    Public
    SSLAutoRotate

    string

    No

    Specifies whether to enable automatic SSL certificate rotation. Valid values:

    • Enable: enables automatic SSL certificate rotation.

    • Disable: disables automatic SSL certificate rotation.

    Enable

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    A94B1755-6D8B-4E27-BF3C-8562BC******

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 EngineMigration.ActionDisabled Specified action is disabled while custins is in engine migration. The specified operation is disabled when custins is being migrated across engines.
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. The specified DBEndpointId parameter is invalid.
    400 InvalidSSLAutoRotate.Malformed The specified SSLAutoRotate is not valid. The specified SSLAutoRotate parameter is invalid.
    400 InvalidNetType.Malformed The specified parameter NetType is not valid. The specified NetType parameter is invalid.
    400 InvalidConnectionString.Malformed The specified parameter ConnectionString is not valid. The specified ConnectionString parameter is invalid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.