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 types of instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx

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.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data. The offset value must be a number but cannot be a negative number.
limit	No	Integer	Maximum records to be queried. The value ranges from 1 to 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	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
histories	Array of ConfigurationHistoryRsp objects	Change history of parameters of an instance.

**Table 5** ConfigurationHistoryRsp
Parameter	Type	Description
parameter_name	String	Parameter name.
old_value	String	Original parameter value.
new_value	String	New parameter value.
update_result	String	Update result. The value can be: SUCCESS, indicating that the parameter value is changed. FAILED, indicating that the parameter value fails to be changed.
applied	Boolean	true indicates the parameter change has taken effect. false indicates that the parameter change does not take effect.
updated_at	String	Update time in the yyyy-MM-ddTHH:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
applied_at	String	Update time in the yyyy-MM-ddTHH:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein10/configuration-histories?offset=0&limit=10

Example Responses

Status code: 200

Success

{
  "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"
  } ]
}