PolarDB SSL Configuration API Reference - PolarDB - Alibaba Cloud - PolarDB

Queries the SSL settings of a PolarDB cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the details of all clusters under your account, including the cluster ID.	pc-************

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C890995A-CF06-4F4D-8DB8-DD26C2******
SSLAutoRotate	string	Indicates whether automatic SSL certificate rotation is enabled. Valid values: Enable: Enabled. Disable: Disabled. Note This parameter is supported only for PolarDB for MySQL.	Enable
Items	array<object>	The list of SSL connection information.
	object
SSLExpireTime	string	The expiration time of the SSL certificate. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2021-11-13T07:14:22Z
SSLEnabled	string	Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values: Enabled: Enabled. Disabled: Shutdown.	Enabled
SSLConnectionString	string	The SSL connection address.	pc-************.mysql.polardb.rds.aliyuncs.com
DBEndpointId	string	The cluster endpoint ID.	pe-************
SSLAutoRotate	string	Indicates whether automatic SSL certificate rotation is enabled. Valid values: Enable: Enabled. Disable: Disabled. Note This parameter is supported only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible.	Enable

Examples

Success response

JSON format

{
  "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-************",
      "SSLAutoRotate": "Enable"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.