Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Templates/ Viewing Parameter Change History of an Instance
Updated on 2025-04-01 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 instance types:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx instances with classic storage
  • GeminiDB Redis instances with classic storage

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 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Explanation:

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.

Constraints:

The value must be a positive number or 0.

Values:

0 or a positive integer

Default value:

0

limit

No

Integer

Explanation:

Maximum records to be queried

Constraints:

N/A

Values:

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

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

histories

Array of ConfigurationHistoryRsp objects

Explanation:

Change history of parameters of an instance.

Table 5 ConfigurationHistoryRsp

Parameter

Type

Description

parameter_name

String

Explanation:

Parameter name

Values:

N/A

old_value

String

Explanation:

Old parameter value

Values:

N/A

new_value

String

Explanation:

New parameter value

Values:

N/A

update_result

String

Explanation:

Update result

Values:

  • SUCCESS
  • FAILED

applied

Boolean

Explanation:

Whether a change is applied

Values:

  • true: A change is applied.
  • false: A change is not applied.

updated_at

String

Explanation:

Update time

Values:

Format: yyyy-MM-ddTHH:mm:ssZ

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

applied_at

String

Explanation:

Time when a change is applied

Values:

Format: yyyy-MM-ddTHH:mm:ssZ

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

Example Request

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

Example Response

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.