Elastic Compute Service (ECS)
Container Compute Service (ACS)
Enables Transport Layer Security (TLS) for a Tair (Redis OSS-compatible) instance.
Operation description
You can also configure SSL encryption in the console. For more information, see Configure SSL encryption.
To specify the earliest supported SSL version, you can call the ModifyInstanceConfig operation to modify the required parameter.
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:
- For mandatory resource types, indicate with a prefix of * .
- 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 |
|---|
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| kvstore:ModifyInstanceSSL | update | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The instance ID. | r-bp1zxszhcgatnx**** |
| SSLEnabled | string | Yes | Specifies whether to enable TLS (SSL) encryption. Valid values:
| Enable |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "AD7E16AA-6B23-43BF-979C-07D957FB****",
"InstanceId": "r-bp1zxszhcgatnx****",
"TaskId": "32184****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameters.Format | Specified parameters is not valid. | The specified parameters are invalid. |
| 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. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | The operation is not supported while the instance is in the current state. The operation is supported only if the instance is in the Running state. |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation is not supported while the instance is being locked. |
| 404 | EnabledSSLNotSupport | Specified region does not support enable ssl. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-03-25 | API Description Update. The Error code has changed | View Change Details |
