All Products
Document Center


Last Updated:Feb 20, 2024

Queries whether TLS (SSL) encryption is enabled for an instance.

Operation description

SSL encryption is supported for ApsaraDB for Redis 2.8 standard master-replica instances, ApsaraDB for Redis 2.8 master-replica cluster instances, and ApsaraDB for Redis 4.0 master-replica cluster instances. You can enable SSL encryption to enhance data transmission security.

You can use one of the following methods to enable or disable SSL encryption or update the SSL certificate for an ApsaraDB for Redis instance:

Note After SSL encryption is enabled, the instance may respond slower.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
  • DBInstance

Request parameters


The ID of the instance.


Response parameters


The ID of the instance.


The ID of the request.


The status of the TLS (SSL) encryption feature. Valid values:

  • Enable: SSL encryption is enabled.
  • Disable: SSL encryption is disabled.

The time when the CA certificate expires.


The common name of the CA certificate. The default value is the internal endpoint of the instance.


The download URL of the CA certificate.



Sample success responses


  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
  "SSLEnabled": "Enable",
  "SSLExpiredTime": "2020-08-05T09:05:53Z",
  "CertCommonName": "r-bp1zxszhcgatnx****",
  "CertDownloadURL": "https://apsaradb-public.oss-ap-sout****-1.aliy****.com/"

Error codes

HTTP status codeError codeError messageDescription
400InvalidRedisVersionPatternRedis db or proxy version does not match specified pattern.-
403IncorrectCharacterTypeCurrent DB instance CharacterType does not support this operation.-
403IncorrectEngineVersionCurrent engine version does not support operations.The operation is not supported by the minor version of the engine. Update the minor version and try again.
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.The instance does not exist in the records. Call the DescribeInstances operation to query the instances that belong to the account.

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

Change history

Change timeSummary of changesOperation
2023-08-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    Added Error Codes: 404
2023-04-11The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.