All Products
Search
Document Center

Tair:DescribeParameterGroupSupportParam

Last Updated:Oct 09, 2024

Queries the parameters that can be configured in parameter templates across different database versions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeParameterGroupSupportParamget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CategorystringNo

The service category. Valid values:

  • standard: ApsaraDB for Redis Community Edition
  • enterprise: ApsaraDB for Redis Enhanced Edition (Tair)
standard
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 or Redis 6.0, set the parameter to 5.0 or 6.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
EngineTypestringNo

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

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

BB73740C-23E2-4392-9DA4-2660C74C****
ResourceListarray<object>

The parameters.

ResourceListobject

The parameters.

DbTypestring

The engine type.

redis
DbVersionstring

The engine version.

5
Categorystring

The service category.

standard
ParamNamestring

The name of the parameter.

rt_threshold_ms

Examples

Sample success responses

JSONformat

{
  "RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
  "ResourceList": [
    {
      "DbType": "redis",
      "DbVersion": "5",
      "Category": "standard",
      "ParamName": "rt_threshold_ms"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history