All Products
Search
Document Center

Tair:ModifyInstanceSSL

Last Updated:May 23, 2024

Modifies the SSL settings of an ApsaraDB for Redis instance.

Operation description

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:ModifyInstanceSSLWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
  • kvstore:SSLEnabled
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
SSLEnabledstringYes

Modifies SSL encryption configurations. Valid values:

  • Disable: The SSL encryption is disabled.
  • Enable: The SSL encryption is enabled.
  • Update: The SSL certificate is updated.
Enable

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

AD7E16AA-6B23-43BF-979C-07D957FB****
InstanceIdstring

The ID of the instance.

r-bp1zxszhcgatnx****
TaskIdstring

The ID of the task.

32184****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
403IncorrectCharacterTypeCurrent DB instance CharacterType does not support this operation.-
403IncorrectEngineVersionCurrent 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.
403IncorrectDBInstanceStateCurrent 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.
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation is not supported while the instance is being locked.
404EnabledSSLNotSupportSpecified region does not support enable ssl.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history