You can call this operation to enable or disable Secure Sockets Layer (SSL) encryption, or update the SSL certificate issued by Certificate Authorities (CA) for an Apsara 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-bpxxxxxxxxxx

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

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 issued by CA.
Note After you enable SSL encryption or update the SSL certificate issued by CA, you must download and configure the certificate.
DBEndpointId String No testxxxxx.mysql.polardb.rds.aliyuncs.com

The endpoint that supports SSL connections.

Note
  • For a PolarDB for MySQL database, this parameter is required.
  • For a PolarDB for PostgreSQL database or a PolarDB database compatible with Oracle, this parameter is not required. By default, SSL encryption is enabled for all endpoints.
NetType String No Public

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

  • Public: the Internet
  • Private: the Virtual Private Cloud (VPC) network
  • Inner: the classic network
Note
  • For a PolarDB for MySQL database, this parameter is required.
  • For a PolarDB for PostgreSQL database or a PolarDB database compatible with Oracle, 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-8562BC8A6893

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ModifyDBClusterSSL
&DBClusterId=pc-bpxxxxxxxxxx
&SSLEnabled=Enable
&<Common request parameters>

Sample success responses

XML format

<RequestId>A94B1755-6D8B-4E27-BF3C-8562BC8A6893</RequestId>

JSON format

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

Error codes

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