DescribeDBClusterSSL - AnalyticDB - Alibaba Cloud Documentation Center

Queries the SSL configurations of a 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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeDBClusterSSL	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	amv-************

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	348303D8-6F42-5141-9B00-A6EECA1E37B6
ExpireTime	string	The validity period of the SSL certificate. Format: yyyy-MM-ddTHH:mm:ssZ(UTC time).	2022-10-11T08:16:43Z
ConnectionString	string	The endpoint that is protected by SSL encryption.	amv-*********.ads.aliyuncs.com
SSLEnabled	boolean	Indicates whether SSL encryption is enabled. Default value: true. Valid values: true: enabled false: disabled	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "348303D8-6F42-5141-9B00-A6EECA1E37B6",
  "ExpireTime": "2022-10-11T08:16:43Z",
  "ConnectionString": "amv-*********.ads.aliyuncs.com",
  "SSLEnabled": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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