All Products
Search
Document Center

:CreateParameterGroup

Last Updated:Dec 19, 2024

Creates a parameter template.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:CreateParameterGroupcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
CategorystringYes

The service category. Valid values:

  • standard: Community Edition
  • enterprise: Enhanced Edition (Tair)
enterprise
EngineTypestringYes

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
EngineVersionstringYes

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
ParameterGroupNamestringYes

The new 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
ParametersstringYes

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"}
ParameterGroupDescstringNo

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

test

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

The parameter template ID.

g-51ii2ienn0dg0xi8****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.

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