Use DescribeParameterTemplates to query parameter templates and default values - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the parameter list and default values of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance for different architectures and major engine versions.

Operation description

After you call this operation to query the parameter list and default values, you can call the ModifyInstanceConfig operation to modify the parameters of a Redis instance based on your business requirements.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CharacterType	string	Yes	The architecture of the instance. For more information, see Architecture overview. Valid values: logic: cluster or read/write splitting architecture. normal: standard architecture (primary/secondary).	logic
Engine	string	Yes	The database type. Set the value to Redis.	Redis
EngineVersion	string	Yes	The major engine version of the instance. Valid values: 4.0, 5.0, 6.0, and 7.0.	5.0
ResourceGroupId	string	No	The resource group ID. You can invoke the ListResourceGroups operation to obtain the resource group ID. Note You can also obtain the resource group ID in the console. Related operations, see View basic information of a resource group.	rg-acfmyiu4ekp****
InstanceId	string	No	The instance ID. You can call the DescribeInstances operation to obtain the instance ID.	r-bp1zxszhcgatnx****
ParameterCategory	string	No	Specifies whether to query the account parameter template. Set the value to account.	account

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	The database type. The return value is fixed as Redis.	redis
EngineVersion	string	The major engine version of the instance.	5.0
ParameterCount	string	The number of parameters.	24
Parameters	object
TemplateRecord	array<object>	The list of parameter details.
	object
CheckingCode	string	The valid values of the parameter.	[yes\|no]
ParameterName	string	The parameter name. For more information about metric descriptions and settings, see Metric description.	appendonly
ParameterValue	string	The default value of the parameter.	yes
ForceModify	boolean	Indicates whether the parameter can be modified. Valid values: true: The parameter can be modified. false: The parameter cannot be modified.	true
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. Valid values: true: A restart is required for the modification to take effect. false: The modification takes effect immediately without a restart.	true
ParameterDescription	string	The description of the parameter.	Enable AOF persistence mode

Examples

Success response

JSON format

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": true,
        "ParameterDescription": "Enable AOF persistence mode"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The parameter is invalid.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.