All Products
Search
Document Center

Tair (Redis® OSS-Compatible):CreateParameterGroup

Last Updated:Oct 26, 2026

Creates a parameter template.

Operation description

Parameter templates apply only to instances in cloud-native deployment mode (formerly cloud disk instances).

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

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

Category

string

Yes

The product category. Valid values:

  • standard: open-source Redis

  • enterprise: Tair (Enterprise Edition)

enterprise

EngineType

string

Yes

The engine type. Valid values:

  • redis: open-source Redis or Tair memory-based

  • tair_pena: Tair persistent memory-based

  • tair_pdb: Tair disk-based (ESSD/SSD)

redis

EngineVersion

string

Yes

The compatible version. Valid values:

  • Open-source Redis supports 5.0, 6.0, and 7.0.

  • Tair memory-based is compatible with Redis 5.0, 6.0, and 7.0 protocols. Set the value to 5.0, 6.0, or 7.0.

  • Tair persistent memory-based is compatible with the Redis 6.0 protocol. Set the value to 1.0.

  • Tair disk-based (ESSD/SSD) is compatible with the Redis 6.0 protocol. To create a parameter template for ESSD-based instances, set the value to 1.0. To create a parameter template for SSD-based instances, set the value to 2.0.

6.0

ParameterGroupName

string

Yes

The name of the parameter template. The name must meet the following requirements:

  • It must contain only letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.

  • It must be 8 to 64 characters in length.

tw_test1

Parameters

string

Yes

The parameters and their corresponding values in JSON format. Format: {"parameter1":"value1","parameter2":"value2"...}.

Note

The parameters that can be added vary by version. Refer to the console for details.

{"hz":"15","#no_loose_disabled-commands":"flushall"}

ParameterGroupDesc

string

No

The description of the parameter template. The description must be 0 to 200 characters in length.

test

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

62DA5BE5-F9C9-527C-ACCB-4D783C297A3A

ParamGroupId

string

The parameter template ID.

g-51ii2ienn0dg0xi8****

Examples

Success response

JSON format

{
  "RequestId": "62DA5BE5-F9C9-527C-ACCB-4D783C297A3A",
  "ParamGroupId": "g-51ii2ienn0dg0xi8****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameters.Format Specified parameters is not valid. The parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.