DescribeInstanceSSL - Tair - Alibaba Cloud Documentation Center

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.

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

Debugging

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

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeInstanceSSL	Read	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
InstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
RequestId	string	The ID of the request.	02260F96-913E-4655-9BA5-A3651CAF****
SSLEnabled	string	The status of the TLS (SSL) encryption feature. Valid values: Enable: SSL encryption is enabled. Disable: SSL encryption is disabled.	Enable
SSLExpiredTime	string	The time when the CA certificate expires.	2020-08-05T09:05:53Z
CertCommonName	string	The common name of the CA certificate. The default value is the internal endpoint of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
CertDownloadURL	string	The download URL of the CA certificate.	https://apsaradb-public.oss-ap-sout**-1.aliy**.com/ApsaraDB-CA-Chain.zip

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 operation is not supported by the minor version of the engine. Update the minor version and try again.
404	InvalidInstanceId.NotFound	The 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 time

Summary of changes

Operation

2023-08-16

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	Added Error Codes: 404

2023-04-11

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
Output Parameters	The response structure of the API has changed.