All Products
Search
Document Center

ApsaraDB for Redis:DescribeParameterTemplates

Last Updated:Nov 03, 2023

Queries the parameters and their default values that are supported by ApsaraDB for Redis instances of different architectures and major versions.

Operation Description

An array that consists of the details about the parameters returned.

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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CharacterTypestringYes

The architecture of the instance. For more information, see Overview. Valid values:

  • logic: The instance is a cluster or read/write splitting instance.
  • normal: The instance is a standard master-replica instance.
logic
EnginestringYes

The operation that you want to perform. Set the value to DescribeParameterTemplates.

Redis
EngineVersionstringYes

The database engine that is run on the instance. The value Redis is returned for this parameter.

5.0
ResourceGroupIdstringNo

The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances.

rg-acfmyiu4ekp****
InstanceIdstringNo

r-bp1zxszhcgatnx****

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The name of the parameter. For more information about the parameters and the parameter settings, see Parameters.

9DA28D8E-514D-4F12-ADED-70A9C818****
Enginestring

The valid values of the parameter.

redis
EngineVersionstring

The default value of the parameter.

5.0
ParameterCountstring

The architecture of the instance. For more information, see Overview. Valid values:

  • logic: The instance is a cluster master-replica instance or a read/write splitting instance.
  • normal: The instance is a standard master-replica instance.
24
Parametersobject []

Details of the returned parameters.

CheckingCodestring

The check code that indicates the valid values of the parameter.

[yes|no]
ParameterNamestring

The name of the parameter. For more information about the parameters and the parameter settings, see Parameters.

appendonly
ParameterValuestring

The default value of the parameter.

yes
ForceModifyboolean

Indicates whether the parameter can be reset. Valid values:

  • true: The parameter can be reset.
  • false: The parameter cannot be reset.
true
ForceRestartboolean

Indicates whether a restart of the instance is required after the parameter is reset. Valid values:

  • true: After the parameter is reset, you must restart the instance to make the new value of the parameter take effect.
  • false: After the parameter is reset, the new value of the parameter immediately takes effect. You do not need to restart the instance.
false
ParameterDescriptionstring

The description of the parameter.

test description

Examples

Sample success responses

JSONformat

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": false,
        "ParameterDescription": "test description"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
403ParamNotSupportedForCurrentVersionParameter is not supported for current version.The error message returned because modifications to parameter values are not supported for the current engine version.

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