All Products
Search

This Product

    PolarDB:ModifyDBClusterSSL

    Document Center

    PolarDB:ModifyDBClusterSSL

    Last Updated:Sep 01, 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:ModifyDBClusterSSL

    update

    *DBCluster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

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

    string

    No

    The SSL status to set. 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: Enabled.

    • Disable: Disabled.

    Enable
    CertValidDays

    string

    No

    The validity period of the SSL certificate. Unit: days. Valid values: 365 and 1095.

    1095
    PfsInstanceId

    string

    No

    The PFS instance ID.

    pfs-xxx
    ConnectionString

    string

    No

    The connection string.

    xxx

    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.