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:
- 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
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 Resourcesis 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 |
|---|---|---|---|---|
| kvstore:DescribeInstanceSSL | get | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. | r-bp1zxszhcgatnx**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"InstanceId": "r-bp1zxszhcgatnx****",
"RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
"SSLEnabled": "Enable",
"SSLExpiredTime": "2020-08-05T09:05:53Z",
"CertCommonName": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"CertDownloadURL": "https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRedisVersionPattern | Redis db or proxy version does not match specified pattern. | - |
| 403 | IncorrectCharacterType | Current DB instance CharacterType does not support this operation. | - |
| 403 | IncorrectEngineVersion | Current engine version does not support operations. | The current Redis version does not support this operation. Please refer to the relevant documentation for this operation to understand the Redis version requirements for this operation. |
| 404 | InvalidInstanceId.NotFound | The InstanceId provided does not exist in our records. | The instance does not exist in our record. You can call the DescribeInstances interface to view the instance information under the current user. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-08-16 | The Error code has changed | View Change Details |
| 2023-04-11 | The Error code has changed. The response structure of the API has changed | View Change Details |