All Products
Search

This Product

    Tair (Redis® OSS-Compatible):CreateParameterGroup

    Document Center

    Tair (Redis® OSS-Compatible):CreateParameterGroup

    Last Updated:Aug 28, 2026

    Creates a parameter template.

    Operation description

    Parameter templates apply only to cloud-native instances (formerly cloud disk-based 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 service category. Valid values:

    • standard: Community Edition

    • enterprise: Enhanced Edition (Tair)

    enterprise
    EngineType

    string

    Yes

    The engine type. Valid values:

    • redis: ApsaraDB for Redis Community Edition instance or Tair DRAM-based instance

    • tair_pena: Tair persistent memory-optimized instance

    • tair_pdb: Tair ESSD/SSD-based instance

    redis
    EngineVersion

    string

    Yes

    The compatible engine version. Valid values:

    • For ApsaraDB for Redis Community 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.

    6.0
    ParameterGroupName

    string

    Yes

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

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

    • The name can be 8 to 64 characters in length.

    tw_test1
    Parameters

    string

    Yes

    A JSON-formatted object that specifies the parameter-value pairs. Format: {"Parameter 1":"Value 1","Parameter 2":"Value 2"...}. The specified value overwrites the original content.

    Note

    The parameters that can be added for different editions are displayed in the console.

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

    string

    No

    The description of the parameter template. It 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.