DescribeParameterGroupTemplateList API Reference - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries configurable parameters in a parameter template, including default values, value ranges, and descriptions.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Category	string	Yes	The service category. Valid values: standard: Redis Open-Source Edition enterprise: Tair (Enterprise Edition)	standard
EngineVersion	string	Yes	The compatible engine version. Valid values: For Redis Open-Source Edition instances, set the parameter to 5.0, 6.0, or 7.0. For Tair DRAM-based instances that are compatible with Redis 5.0, 6.0, or 7.0, set the parameter to 5.0, 6.0, or 7.0. For Tair persistent memory-optimized instances that are compatible with Redis 6.0, set the parameter to 1.0. For Tair ESSD-based instances that are compatible with Redis 6.0, set the parameter to 1.0. For Tair SSD-based instances that are compatible with Redis 6.0, set the parameter to 2.0.	5.0
EngineType	string	Yes	The engine type. Valid values: redis: Redis Open-Source Edition or Tair (In-Memory) tair_pena: Tair (On NVM) tair_pdb: Tair (On Disk)	redis
CharacterType	string	No	The role of the instance. Valid values: logic (logical instance), db (database instance), proxy (proxy node), cs (ConfigServer node), and normal (master-replica database instance).	db

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	5D622714-AEDD-4609-9167-F5DDD3D1****
EngineVersion	string	The compatible engine version. Valid values: Redis Open Source 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 parameter details.
	object
SupportModifyForMinorVersion	boolean	Whether the minor version can be changed. Valid values: true and false.	true
CheckingCode	string	The regular expression used to validate input.	[0\|1]
ParameterValue	string	The default value of the parameter.	10
Revisable	integer	Indicates whether the parameter can be modified. Valid values: 0: The parameter cannot be modified. 1: The parameter can be modified.	0
Factor	integer	The divisor of the parameter value. For integer or byte type parameters, valid values must be a multiple of this divisor unless it is set to 0.	1
ParameterName	string	The parameter name.	appendonly
Unit	string	The unit of the parameter value. Valid values: INT (integer), STRING (fixed string), and B (byte).	STRING
ParameterDescription	string	The description of the parameter.	开启Aof持久化模式。
Effective	integer	Whether the modification takes effect. Valid values: 0 (does not take effect) and 1 (takes effect).	1

Examples

Success response

JSON format

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "EngineVersion": "5",
  "Parameters": [
    {
      "SupportModifyForMinorVersion": true,
      "CheckingCode": "[0|1]",
      "ParameterValue": "10",
      "Revisable": 0,
      "Factor": 1,
      "ParameterName": "appendonly",
      "Unit": "STRING",
      "ParameterDescription": "开启Aof持久化模式。",
      "Effective": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.