Use ModifyInstanceConfig to modify instance parameter settings - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Modifies the parameter settings of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.

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

update

*DBInstance

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

kvstore:InstanceAofConfig
kvstore:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
Config	string	No	The instance parameters to modify, in JSON format. The new values overwrite the existing values. For example, if you want to set only the maxmemory-policy parameter to noeviction, pass in `{"maxmemory-policy":"noeviction"}`. Note For more information about each parameter, see Metric description.	{"maxmemory-policy":"volatile-lru","zset-max-ziplist-entries":128,"zset-max-ziplist-value":64,"hash-max-ziplist-entries":512,"set-max-intset-entries":512}
ParamReplMode	string	No	The synchronization pattern. Valid values: async (default): asynchronous semisync: semi-synchronous.	async
ParamSemisyncReplTimeout	string	No	The degradation threshold for semi-synchronous mode. This parameter is supported only in semi-synchronous mode. Unit: ms. Valid values: 10 to 60000. Default value: 500. Note When the synchronization latency exceeds this threshold, the synchronous mode automatically transforms to asynchronous. When the latency is eliminated, the synchronous mode automatically transforms back to semi-synchronous. This parameter is supported only by Tair Enterprise instances. This feature is in public preview.	500
ParamNoLooseSentinelEnabled	string	No	The Sentinel compatibility mode. This parameter applies to non-cluster instances. Valid values: no (default): disabled. yes: enabled. Note For more information, see Sentinel compatibility mode.	yes
ParamSentinelCompatEnable	string	No	The Sentinel compatibility mode. This parameter applies to instances that use the proxy connection mode in cluster architecture or instances that use the read/write splitting architecture. Valid values: 0 (default): disabled. 1: enabled. Note For more information, see Sentinel compatibility mode.	1
ParamNoLooseSentinelPasswordFreeAccess	string	No	Specifies whether to allow password-free execution of Sentinel-related commands when Sentinel mode is enabled. Valid values: no (default): disabled. yes: enabled. After this parameter is enabled, you can run Sentinel commands without a password on any connection and use the SENTINEL command to listen on the +switch-master channel.	****
ParamNoLooseSentinelPasswordFreeCommands	string	No	After Sentinel mode and the ParamNoLooseSentinelPasswordFreeAccess parameter are enabled, use this parameter to add additional password-free commands (empty by default). Note After this parameter is set, the specified commands can be run without a password on any connection. Proceed with caution. Commands must be in lowercase letters. Separate multiple commands with commas (,).	****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

Examples

Success response

JSON format

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The parameter is invalid.
400	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.
403	InstanceType.NotSupport	Current instance type does not support this operation.
403	NetworkType.NotSupport	Current network type does not support this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.