You can call this operation to query Secure Sockets Layer (SSL) settings of 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 DescribeDBClusterSSL

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

DBClusterId String Yes pc-bpxxxxxxxxxx

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

Response parameters

Parameter Type Example Description
RequestId String 3236BE7D-A429-45CE-9B83-783DB5E56523

The ID of the request.

Items Array

The list of SSL connections.

DBEndpointId String pe-bpxxxxxxxxxx

The ID of the cluster endpoint.

SSLEnabled String Enabled

The status of SSL encryption. Valid values:

  • Enabled: indicates that SSL encryption is enabled.
  • Disabled: indicates that SSL encryption is disabled.
SSLConnectionString String ssltestxxxxxxxx.mysql.polardb.rds.aliyuncs.com

The SSL connection string.

SSLExpireTime String 2021-02-17T08:25:32

The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Examples

Sample requests

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

Sample success responses

XML format

<Items>
    <SSLEnabled>Enabled</SSLEnabled>
    <SSLExpireTime>2021-02-17T08:25:32Z</SSLExpireTime>
    <DBEndpointId>pe-bpxxxxxxxxxx</DBEndpointId>
    <SSLConnectionString>ssltestxxxxxxxx.mysql.polardb.rds.aliyuncs.com</SSLConnectionString>
</Items>
<RequestId>3236BE7D-A429-45CE-9B83-783DB5E56523</RequestId>

JSON format

{
    "Items": [
        {
            "SSLEnabled": "Enabled",
            "SSLExpireTime": "2021-02-17T08:25:32Z",
            "DBEndpointId": "pe-bpxxxxxxxxxx",
            "SSLConnectionString": "ssltestxxxxxxxx.mysql.polardb.rds.aliyuncs.com"
        }
    ],
    "RequestId": "3236BE7D-A429-45CE-9B83-783DB5E56523"
}

Error codes

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