Updated on 2026-09-22 GMT+08:00

Viewing Parameter Change History of an Instance

Function

This API is used to view change history of parameters of an instance.

Constraints

This API supports the following instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx
GeminiDB Redis

This API can be used to query only the past seven days of parameter changes.

GeminiDB Influx does not allow you to view parameter change history of single-node instances.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

gaussdbfornosql:configuration:listUpdatedHistory

List

-

-

nosql:param:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:configuration:listUpdatedHistory	List	-	-	nosql:param:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/configuration-histories

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
parameter_name	No	String	Definition Parameter name. Fuzzy search is supported. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data. Constraints The value must be a non-negative number. Range Non-negative integer Default Value 0
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1 to 100 Default Value 100: If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
histories	Array of ConfigurationHistoryRsp objects	Definition Change history of parameters of an instance.
total_count	Integer	Definition Total number of parameter change records Range N/A

**Table 5** ConfigurationHistoryRsp
Parameter	Type	Description
parameter_name	String	Definition Parameter name Range N/A
old_value	String	Definition Old parameter value Range N/A
new_value	String	Definition New parameter value Range N/A
update_result	String	Definition Update result Range SUCCESS FAILED
applied	Boolean	Definition Whether a change is applied Range true: A change is applied. false: A change is not applied.
updated_at	String	Definition Update time. The format is yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
applied_at	String	Definition Time when a change is applied. The format is yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A

Example Requests

URI example

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein10/configuration-histories?offset=0&limit=10

Example Responses

Status code: 200

Success

{
  "total_count" : 1,
  "histories" : [ {
    "parameter_name" : "mongos.connPoolMaxShardedConnsPerHost",
    "old_value" : "600",
    "new_value" : "500",
    "update_result" : "FAILED",
    "applied" : true,
    "updated_at" : "2022-09-20T11:17:04+0000",
    "applied_at" : "2022-09-20T11:17:04+0000"
  } ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration