Enables or disables SSL encryption, or updates the SSL certificate that is 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 cluster.
SSLEnabled String Yes Enable

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

  • Disable: disables SSL encryption.
  • Enable: enables SSL encryption.
  • Update: updates the SSL certificate.
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
  • For a PolarDB for MySQL cluster, this parameter is required.
  • For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required. 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: the Internet.
  • Private: the virtual private cloud (VPC).
  • Inner: the classic network.
Note
  • For a PolarDB for MySQL cluster, this parameter is required.
  • For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required. By default, SSL encryption is enabled for all endpoints.

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 

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

JSON format 

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

Error codes

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