Modifies SSL encryption configurations for an ApsaraDB for Redis instance.

You can also modify SSL encryption configurations in the ApsaraDB for Redis console. For more information, see Configure SSL encryption.

Note To specify the earliest supported SSL version, you can call the ModifyInstanceConfig operation to modify the required parameter.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyInstanceSSL

The operation that you want to perform. Set the value to ModifyInstanceSSL.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.
SSLEnabled String Yes Enable

Modifies SSL encryption configurations. Valid values:

  • Disable: The SSL encryption is disabled.
  • Enable: The SSL encryption is enabled.
  • Update: The SSL certificate is updated.
RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
InstanceId String r-bp1zxszhcgatnx****

The ID of the instance.
TaskId String 32184****

The ID of the task.
RequestId String AD7E16AA-6B23-43BF-979C-07D957FB****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=ModifyInstanceSSL
&InstanceId=r-bp1zxszhcgatnx****
&SSLEnabled=Enable
&<Common request parameters>

Sample success responses

XML format 

<ModifyInstanceSSLResponse>
      <TaskId>32184****</TaskId>
      <RequestId>AD7E16AA-6B23-43BF-979C-07D957FB****</RequestId>
      <InstanceId>r-bp1zxszhcgatnx****</InstanceId>
</ModifyInstanceSSLResponse>

JSON format 

{
	"TaskId": "32184****",
	"RequestId": "AD7E16AA-6B23-43BF-979C-07D957FB****",
	"InstanceId": "r-bp1zxszhcgatnx****"
}

Error codes

HttpCode Error code Error message Description
403 IncorrectDBInstanceState Current DB instance state does not support this operation. The error message returned because the status of the instance does not support this operation. This operation is supported only when the instance is in the running state.
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. The error message returned because the current lock mode of the instance does not support this operation.
400 InvalidParameters.Format Specified parameters is not valid. The error message returned because the specified parameters are invalid.

For a list of error codes, visit the API Error Center.