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
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
CharacterType | string | Yes | The architecture of the instance. For more information, see Overview. Valid values:
| logic |
Engine | string | Yes | The operation that you want to perform. Set the value to DescribeParameterTemplates. | Redis |
EngineVersion | string | Yes | The database engine that is run on the instance. The value Redis is returned for this parameter. | 5.0 |
ResourceGroupId | string | No | The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances. | rg-acfmyiu4ekp**** |
InstanceId | string | No | r-bp1zxszhcgatnx**** | r-bp1zxszhcgatnx**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameters.Format | Specified parameters is not valid. | The specified parameters are invalid. |
403 | ParamNotSupportedForCurrentVersion | Parameter 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.