Call the ModifyInstanceSSL API to manage SSL/TLS encryption - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also configure SSL encryption in the 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:ModifyInstanceSSL

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

kvstore:SSLEnabled

None

Request parameters

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: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.	Enable

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AD7E16AA-6B23-43BF-979C-07D957FB****
InstanceId	string	The instance ID.	r-bp1zxszhcgatnx****
TaskId	string	The ID of the task.	32184****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The parameter is invalid.
403	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	The operation cannot be performed until the instance is in the running state.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	EnabledSSLNotSupport	Specified region does not support enable ssl.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.