All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeParameterModificationHistory

Last Updated:Aug 28, 2026

Queries the parameter modification history of a Tair (Redis OSS-compatible) instance.

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:DescribeParameterModificationHistory

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID. You can call DescribeInstances to query instance IDs.

r-bp1zxszhcgatnx****

NodeId

string

No

The node ID.

Note

Specify this parameter to query the parameter modification history of a specific node in a cluster instance.

r-bp1xxxxxxxxxxxxx-db-0

StartTime

string

Yes

The start of the time range to query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

2022-09-05T08:49:27Z

EndTime

string

Yes

The end of the time range to query. Must be later than StartTime. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

2022-09-05T09:49:27Z

ParameterName

string

No

The name of the parameter.

script_check_enable

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

963C20F0-7CE1-4591-AAF3-6F3CD1CE****

HistoricalParameters

object

HistoricalParameter

array<object>

The modification records of the parameters.

object

The modification records of the parameter.

OldParameterValue

string

The parameter value before modification.

-2

ParameterName

string

The parameter name.

script_check_enable

NewParameterValue

string

The parameter value after modification.

0

ModifyTime

string

The time when the parameter was modified. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

2022-09-05T09:56:10Z

Examples

Success response

JSON format

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "HistoricalParameters": {
    "HistoricalParameter": [
      {
        "OldParameterValue": "-2",
        "ParameterName": "script_check_enable",
        "NewParameterValue": "0",
        "ModifyTime": "2022-09-05T09:56:10Z"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.