Checks whether Secure Socket Layer (SSL) encryption is enabled for an ApsaraDB for Redis instance.
The standard and cluster Instances of Redis 2.8 and the cluster instances of Redis 4.0 support secure sockets layer (SSL) encryption. You can enable SSL encryption to enhance data transmission security.
You can enable or disable SSL encryption or update the SSL certificate for an ApsaraDB for Redis instance in the following ways:
- Call the ModifyInstanceSSL operation.
- Enable or disable SSL encryption or update the SSL certificate in the ApsaraDB for Redis console. For more information, see Configure SSL encryption.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInstanceSSL |
The operation that you want to perform. Set the value to DescribeInstanceSSL. |
InstanceId | String | Yes | r-bp1zxszhcgatnx**** |
The ID of the instance that was queried. |
RegionId | String | No | cn-hangzhou |
The ID of the region where the instance is deployed. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
SSLEnabled | String | Enable |
Indicates whether SSL encryption is enabled. Valid values:
|
SSLExpiredTime | String | 2020-08-05T09:05:53Z |
The expiration time of the SSL certificate. |
InstanceId | String | r-bp1zxszhcgatnx**** |
The ID of the instance. |
RequestId | String | 02260F96-913E-4655-9BA5-A3651CAF**** |
The ID of the request. |
CertCommonName | String | r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
The common name of the SSL certificate, which is the domain name for which you want to apply for the SSL certificate. The default value is the internal endpoint of the instance. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=DescribeInstanceSSL
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>
Sample success responses
XML
format
<DescribeInstanceSSLResponse>
<SSLEnabled>Enable</SSLEnabled>
<SSLExpiredTime>2020-08-05T09:05:53Z</SSLExpiredTime>
<InstanceId>r-bp1zxszhcgatnx****</InstanceId>
<RequestId>02260F96-913E-4655-9BA5-A3651CAF****</RequestId>
<CertCommonName>r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com</CertCommonName>
</DescribeInstanceSSLResponse>
JSON
format
{
"SSLEnabled": "Enable",
"SSLExpiredTime": "2020-08-05T09:05:53Z",
"InstanceId": "r-bp1zxszhcgatnx****",
"RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
"CertCommonName": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com"
}
Error codes
For a list of error codes, visit the API Error Center.