You can call this operation to check whether Secure Socket Layer (SSL) encryption is enabled for an ApsaraDB for Redis instance.

ApsaraDB for Redis instances of the standard edition in Redis 2.8, the cluster edition in Redis 2.8, and the cluster edition in Redis 4.0 support SSL encryption. You can enable SSL encryption to improve data transmission security.

You can enable or disable SSL encryption or update the SSL certificate for an ApsaraDB for Redis instance in either of the following ways:

Note After SSL encryption is enabled, the instance responds slower.

Debugging

You can call this operation in OpenAPI Explorer without the need to manually calculate the signature. After you call the operation, OpenAPI Explorer can automatically generate SDK example code.

Request parameters

Parameter Type Required Example Description
InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance for which you want to check whether SSL encryption is enabled.

Action String No DescribeInstanceSSL

The operation that you want to perform. Set this parameter to DescribeInstanceSSL.

AccessKeyId String No Lxxxxxxxxxxxxxxw

The AccessKey ID that Alibaba Cloud provides for you to access services.

Response parameters

Parameter Type Example Description
SSLEnabled String Enable

Indicates whether SSL encryption is enabled. Valid values:

  • Enable: The SSL encryption is enabled.
  • Disable: The SSL encryption is disabled.
SSLExpiredTime String 2020-08-05T09:05:53Z

The expiration time of the SSL certificate.

InstanceId String r-bp1xxxxxxxxxxxxx

The ID of the instance.

RequestId String 02260F96-913E-4655-9BA5-A3651CAF3045

The ID of the request.

CertCommonName String r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com

The common name of the SSL certificate. The common name is usually the domain name for which the SSL certificate is applied. The default value of this parameter is the internal endpoint of the instance.

Examples

Sample request


https://r-kvstore.aliyuncs.com/
? Action=DescribeInstanceSSL
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

Sample success response

XML format

<DescribeInstanceSSLResponse>
	  <SSLEnabled>Enable</SSLEnabled>
	  <SSLExpiredTime>2020-08-05T09:05:53Z</SSLExpiredTime>
	  <InstanceId>r-r-bp1xxxxxxxxxxxxx</InstanceId>
	  <RequestId>02260F96-913E-4655-9BA5-A3651CAF3045</RequestId>
	  <CertCommonName>r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com</CertCommonName>
</DescribeInstanceSSLResponse>

JSON format

{
	"SSLEnabled":"Enable",
	"SSLExpiredTime":"2020-08-05T09:05:53Z",
	"RequestId":"02260F96-913E-4655-9BA5-A3651CAF3045",
	"InstanceId":"r-bp1xxxxxxxxxxxxx",
	"CertCommonName":"r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com"
}

Error codes

For more information, see Error codes.