All Products
Search
Document Center

PolarDB:DescribeDBClusterSSL

Last Updated:Nov 07, 2023

Queries the Secure Sockets Layer (SSL) settings of a PolarDB cluster.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBClusterSSLREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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.
pc-************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C890995A-CF06-4F4D-8DB8-DD26C2******
SSLAutoRotatestring

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

  • Enable: The feature is enabled.
  • Disable: The feature is disabled.
Note This parameter is valid only for a PolarDB for MySQL cluster.
Enable
Itemsobject []

The list of SSL connections.

SSLExpireTimestring

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

2021-11-13T07:14:22Z
SSLEnabledstring

Indicates whether SSL encryption is enabled. Valid values:

  • Enabled: SSL is enabled.
  • Disable: SSL is disabled.
Enabled
SSLConnectionStringstring

The SSL connection string.

pc-************.mysql.polardb.rds.aliyuncs.com
DBEndpointIdstring

The ID of the endpoint.

pe-************

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.