All Products
Search

This Product

    Tair (Redis® OSS-Compatible):ModifyInstanceConfig

    Document Center

    Tair (Redis® OSS-Compatible):ModifyInstanceConfig

    Last Updated:Apr 23, 2025

    Modifies the parameter settings of an ApsaraDB for Redis instance.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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 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:ModifyInstanceConfigupdate
    *DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    • kvstore:InstanceAofConfig
    • kvstore:TLSVersion
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    ConfigstringYes

    The instance parameter settings that you want to modify. Specify this parameter in the JSON format. The new value of a parameter overwrites the original value.

    **

    Description For more information, see Supported parameters.

    		{"maxmemory-policy":"volatile-lru","zset-max-ziplist-entries":128,"zset-max-ziplist-value":64,"hash-max-ziplist-entries":512,"set-max-intset-entries":512}
    ParamReplModestringNo

    The synchronization mode.

    • semisync
    • async
    		async
    ParamSemisyncReplTimeoutstringNo

    The degradation threshold time of the semi-synchronous replication mode. This parameter is required only when semi-synchronous replication is enabled. Unit: milliseconds. Valid values: 10 to 60000.

    		****
    ParamNoLooseSentinelEnabledstringNo

    The Sentinel-compatible mode, which is applicable to non-cluster instances. For more information about the parameter, see the relevant documentation.

    		yes
    ParamSentinelCompatEnablestringNo

    The Sentinel-compatible mode, which is applicable to cluster instances in proxy mode or read/write splitting instances. For more information about the parameter, see the relevant documentation.

    		1
    ParamNoLooseSentinelPasswordFreeAccessstringNo

    Specifies whether to allow Sentinel commands to be run without requiring a password when the Sentinel mode is enabled. Valid values: Valid values: yes and no. Default value: no. After you set this parameter to yes, you can run Sentinel commands in a virtual private cloud (VPC) without the need to enable the password-free access feature.

    		****
    ParamNoLooseSentinelPasswordFreeCommandsstringNo

    After you enable the Sentinel mode and set the ParamNoLooseSentinelPasswordFreeAccess parameter to yes, you can use this parameter to specify an additional list of commands that can be run without requiring a password. By default, this parameter is empty. After you configure this parameter, you can run the specified commands without a password on any connection. Proceed with caution. The commands must be written in lowercase letters. Separate multiple commands with commas (,).

    		****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
    400ParamNotSupportedForCurrentVersionParameter is not supported for current version.The error message returned because modifications to parameter values are not supported for the current engine version.
    403InstanceType.NotSupportCurrent instance type does not support this operation.The current instance type does not support this operation
    403NetworkType.NotSupportCurrent network type does not support this operation.-

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

    Change history

    Change timeSummary of changesOperation
    2025-03-25API Description Update. The Error code has changedView Change Details
    2024-12-11The Error code has changed. The request parameters of the API has changedView Change Details
    2024-12-03The Error code has changed. The request parameters of the API has changedView Change Details
    2024-11-05The Error code has changed. The request parameters of the API has changedView Change Details