Tair Redis Parameter Templates Overview - Tair - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries basic information about a specified parameter template.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
ParameterGroupId	string	Yes	The parameter template ID.	rpg-sys-00*****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A501A191-BD70-5E50-98A9-C2A486A82****
ParameterGroup	object	The information about the parameter template.
EngineVersion	string	The compatible engine version.	5.0
Modified	string	The time when the parameter template was last modified.	2023-04-18 16:32:45
ParameterGroupName	string	The name of the parameter template.	testGroupName
ParameterGroupDesc	string	The description of the parameter template.	test
Engine	string	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
ParamGroupId	string	The parameter template ID. This ID is globally unique.	sys-001*****
Created	string	The time when the parameter template was created.	2023-04-18 16:32:45
Category	integer	The service category. Valid values: 0: Redis Open-Source Edition 1: Tair (Enterprise Edition)	1
ParamGroupsDetails	array<object>	The parameters configured in the template.
	object
ParamName	string	The parameter name.	timeout
ParamValue	string	The parameter value.	1000

Examples

Success response

JSON format

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "ParameterGroup": {
    "EngineVersion": "5.0",
    "Modified": "2023-04-18 16:32:45",
    "ParameterGroupName": "testGroupName",
    "ParameterGroupDesc": "test",
    "Engine": "redis",
    "ParamGroupId": "sys-001*****",
    "Created": "2023-04-18 16:32:45",
    "Category": 1,
    "ParamGroupsDetails": [
      {
        "ParamName": "timeout",
        "ParamValue": "1000"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.