Queries the Secure Sockets Layer (SSL) settings of 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 Yes DescribeDBClusterSSL

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

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

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.

Response parameters

Parameter Type Example Description
RequestId String C890995A-CF06-4F4D-8DB8-DD26C2******

The ID of the request.

SSLAutoRotate String Enable

Indicates whether automatic rotation of SSL certificates is enabled. Valid values:

  • Enable
  • Disable
Note This parameter is valid only for PolarDB for MySQL clusters.
Items Array of Item

The list of SSL connections.

SSLExpireTime String 2021-11-13T07:14:22Z

The time when the server certificate expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

SSLEnabled String Enabled

Indicates whether SSL encryption is enabled. Valid values:

  • Enabled: TDE is enabled.
  • Disable: TDE is disabled.
SSLConnectionString String pc-************.mysql.polardb.rds.aliyuncs.com

The SSL connection string.

DBEndpointId String pe-************

The ID of the cluster endpoint.

Examples

Sample requests

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

Sample success responses

XML format 

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

<DescribeDBClusterSSLResponse>
    <RequestId>C890995A-CF06-4F4D-8DB8-DD26C2******</RequestId>
    <SSLAutoRotate>Enable</SSLAutoRotate>
    <Items>
        <SSLExpireTime>2021-11-13T07:14:22Z</SSLExpireTime>
        <SSLEnabled>Enabled</SSLEnabled>
        <SSLConnectionString>pc-************.mysql.polardb.rds.aliyuncs.com</SSLConnectionString>
        <DBEndpointId>pe-************</DBEndpointId>
    </Items>
</DescribeDBClusterSSLResponse>

JSON format 

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

{
  "RequestId" : "C890995A-CF06-4F4D-8DB8-DD26C2******",
  "SSLAutoRotate" : "Enable",
  "Items" : [ {
    "SSLExpireTime" : "2021-11-13T07:14:22Z",
    "SSLEnabled" : "Enabled",
    "SSLConnectionString" : "pc-************.mysql.polardb.rds.aliyuncs.com",
    "DBEndpointId" : "pe-************"
  } ]
}

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist in the current record.

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