DescribeParameterTemplates - Tair (Redis® OSS-Compatible)

Queries the parameters and their default values that are supported by ApsaraDB for Redis instances of different architectures and major versions.

Operation description

After you call this operation to query the parameters and default values of an instance, you can call the ModifyInstanceConfig operation to reconfigure the parameters of the 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeParameterTemplates	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
CharacterType	string	Yes	The architecture of the instance. For more information, see Overview . Valid values: logic: The instance is a cluster master-replica instance or a read/write splitting instance. normal: The instance is a standard master-replica instance.	logic
Engine	string	Yes	The database engine that is run on the instance. Set the value to Redis.	Redis
EngineVersion	string	Yes	The major version that is run on the instance. Valid values: 2.8, 4.0, and 5.0.	5.0
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. You can call the ListResourceGroups operation to query the IDs of resource groups. Note You can also query the ID of a resource group in the Resource Management console. For more information, see View the basic information of a resource group.	rg-acfmyiu4ekp****
InstanceId	string	No	The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	The database engine that is run on the instance. The value Redis is returned for this parameter.	redis
EngineVersion	string	The major version that is run on the instance.	5.0
ParameterCount	string	The number of parameters that are supported by the instance.	24
Parameters	array<object>	An array that consists of the details about the parameters returned.
TemplateRecord	object
CheckingCode	string	The valid values of the parameter.	[yes\|no]
ParameterName	string	The name of the parameter. For more information about the parameters and the parameter settings, see Parameters .	appendonly
ParameterValue	string	The default value of the parameter.	yes
ForceModify	boolean	Indicates whether the parameter can be reconfigured. Valid values: true: The parameter can be reconfigured. false: The parameter cannot be reconfigured.	true
ForceRestart	boolean	Indicates whether a restart of the instance is required after the parameter is reconfigured. Valid values: true: After the parameter is reconfigured, you must restart the instance to make the new value of the parameter take effect. false: After the parameter is reconfigured, the new value of the parameter immediately takes effect. You do not need to restart the instance.	true
ParameterDescription	string	The description of the parameter.	test description

Examples

Sample success responses

JSONformat

{
  "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": "test description\n"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The specified parameters are invalid.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.	The error message returned because modifications to parameter values are not supported for the current engine version.

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

Change history

Change time	Summary of changes	Operation

No change history