Queries SSL settings of a PolarDB-X instance.

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

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeDBInstanceSSL

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

DBInstanceNameStringNopxc-*********

The ID of the instance.

RegionIdStringNocn-hangzhou

The ID of the region.

Response parameters

ParameterTypeExampleDescription
RequestIdStringC458B1E8-1683-3645-B154-6BA32080EEA

The ID of the request.

DataObject

The data that is returned.

SSLEnabledBooleanfalse

Indicates whether SSL encryption is enabled.

  • true: enabled.
  • false: disabled.
SSLExpiredTimeString2022-11-04T09:39:07Z

The expiration time of the certificate.

CertCommonNameStringpxc-sddddddcym7g7wj7kv.polarx.singapore.rds.aliyuncs.com

The domain name to which the certificate is bound.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstanceSSL
&DBInstanceName=pxc-*********
&RegionId=cn-hangzhou   
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBInstanceSSLResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <SSLEnabled>false</SSLEnabled>
        <SSLExpiredTime>2022-11-04T09:39:07Z</SSLExpiredTime>
        <CertCommonName>pxc-sddddddcym7g7wj7kv.polarx.singapore.rds.aliyuncs.com</CertCommonName>
    </Data>
</DescribeDBInstanceSSLResponse>

JSON format

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

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data" : {
    "SSLEnabled" : false,
    "SSLExpiredTime" : "2022-11-04T09:39:07Z",
    "CertCommonName" : "pxc-sddddddcym7g7wj7kv.polarx.singapore.rds.aliyuncs.com"
  }
}

Error codes

HttpCodeError codeError messageDescription
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.The error message returned because the request uses the same token that is used by a non-identical request. Only identical requests can use the same client token.
400InvalidActionThe specified Action is invalid.The error message returned because the Action parameter is invalid.
500InternalErrorAn error occurred while processing your request.The error message returned because an error occurred when the operation is called.
404InvalidDBInstance.NotFoundThe specified DB instance does not exist.The error message returned because the specified database instance does not exist.

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