DescribeParameterGroupTemplateList - Tair (Redis® OSS-Compatible)

Queries the information about the parameters that can be configured in a parameter template, such as the default values, value ranges, and descriptions.

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:DescribeParameterGroupTemplateList	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Category	string	Yes	The service category. Valid values: standard: Community Edition enterprise: Enhanced Edition (Tair)	standard
EngineVersion	string	Yes	The compatible engine version. Valid values: ApsaraDB for Redis Community Edition: 5.0, 6.0, and 7.0. Tair DRAM-based instances: 5.0 and 6.0. Tair persistent memory-optimized instances: 6.0. Tair ESSD-based instances: 4.0.	5.0
EngineType	string	Yes	The engine type. Valid values: redis: Redis or Tair DRAM-based instance tair_pena: Tair persistent memory-optimized instance tair_pdb: Tair ESSD-based instance	redis
CharacterType	string	No	The role of the instance. Valid values: logic: logical instance. db: database instance. proxy: proxy node. cs: ConfigServer node. normal: master-replica database instance.	db

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	5D622714-AEDD-4609-9167-F5DDD3D1****
EngineVersion	string	The compatible engine version. Valid values: ApsaraDB for Redis Community Edition: 5.0, 6.0, and 7.0. Tair DRAM-based instances: 5.0 and 6.0. Tair persistent memory-optimized instances: 6.0. Tair ESSD-based instances: 4.0.	5
Parameters	array<object>	The information about parameters.
Parameters	object
SupportModifyForMinorVersion	boolean	Indicates whether the minor version can be changed. Valid values: true and false.	true
CheckingCode	string	The regular expression used to validate input.	"\\d+\\s+\\d+\\s+\\d+"
ParameterValue	string	The default value of the parameter.	10
Revisable	long	Indicates whether the parameter can be modified. Valid values: 0: The parameter cannot be modified. 1: The parameter can be modified.	0
Factor	long	A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.	1
ParameterName	string	The parameter name.	appendonly
Unit	string	The unit of the parameter value. Valid values: INT (ordinary integer), STRING (fixed string), and B (byte).	STRING
ParameterDescription	string	The description of the parameter.
Effective	long	Indicates whether the modification takes effect. Valid values: 0 and 1. A value of 0 indicates that the modification does not take effect. A value of 1 indicates that the modification takes effect.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "EngineVersion": "5",
  "Parameters": [
    {
      "SupportModifyForMinorVersion": true,
      "CheckingCode": "\"\\\\d+\\\\s+\\\\d+\\\\s+\\\\d+\"",
      "ParameterValue": "10",
      "Revisable": 0,
      "Factor": 1,
      "ParameterName": "appendonly",
      "Unit": "STRING",
      "ParameterDescription": "",
      "Effective": 1
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history