Enables or disables Security Socket Layer (SSL) encryption or updates the SSL certificate issued by Certificate Authorities (CA) for a PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No ModifyDBClusterSSL

The operation that you want to perform. Set the value to ModifyDBClusterSSL.

DBClusterId String Yes pc-************

The ID of the PolarDB cluster that you want to manage.

SSLEnabled String No Enable

Specifies how to modify the SSL encryption status. Valid values:

  • Disable: SSL encryption is disabled.
  • Enable: SSL encryption is enabled.
  • Update: The SSL certificate is updated.
Note After you enable SSL encryption or update the SSL certificate, you must download and configure the certificate. For more information, see Configure SSL encryption.
DBEndpointId String No pe-******************

The ID of the endpoint.

Note
  • This parameter is required for a ApsaraDB PolarDB MySQL-compatible edition cluster.
  • This parameter is not required for a ApsaraDB PolarDB PostgreSQL-compatible edition cluster or a ApsaraDB PolarDB O Edition cluster. By default, SSL encryption is enabled for all endpoints.
  • You can call the DescribeDBClusterSSL operation to view the details of the endpoint.
NetType String No Public

The network type supported by the endpoint that is specified by DBEndpointId. Valid values:

  • Public: Internet
  • Private: virtual private cloud (VPC)
  • Inner: the classic network
Note
  • This parameter is required for a ApsaraDB PolarDB MySQL-compatible edition cluster.
  • This parameter is not required for a ApsaraDB PolarDB PostgreSQL-compatible edition cluster or a ApsaraDB PolarDB O Edition cluster. By default, SSL encryption is enabled for all endpoints.
SSLAutoRotate String No Enable

Specifies whether automatic rotation of SSL certificates is enabled.

  • Enable: Automatic rotation of SSL certificates is enabled.
  • Disable: Automatic rotation of SSL certificates is disabled.

Response parameters

Parameter Type Example Description
RequestId String A94B1755-6D8B-4E27-BF3C-8562BC******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterSSL
&DBClusterId=pc-************
&SSLEnabled=Enable
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBClusterSSLResponse>
<RequestId>A94B1755-6D8B-4E27-BF3C-8562BC******</RequestId>
</ModifyDBClusterSSLResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.