DescribeDBInstanceSSL - PolarDB - Alibaba Cloud ドキュメントセンター

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


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstanceSSL	The operation that you want to perform. Set the value to DescribeDBInstanceSSL.
DBInstanceName	String	No	pxc-*********	The ID of the instance.
RegionId	String	No	cn-hangzhou	The ID of the region.

Response parameters


Parameter	Type	Example	Description
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	The ID of the request.
Data	Object		The data that is returned.
SSLEnabled	Boolean	false	Indicates whether SSL encryption is enabled. true: enabled. false: disabled.
SSLExpiredTime	String	2022-11-04T09:39:07Z	The expiration time of the certificate.
CertCommonName	String	pxc-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


HttpCode	Error code	Error message	Description
400	IdempotentParameterMismatch	The 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.
400	InvalidAction	The specified Action is invalid.	The error message returned because the Action parameter is invalid.
500	InternalError	An error occurred while processing your request.	The error message returned because an error occurred when the operation is called.
404	InvalidDBInstance.NotFound	The 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.