更新时间:2025-08-22 GMT+08:00

查询实例参数的修改历史

功能介绍

查询实例参数的修改历史。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

entity_id

String

参数解释:

实例ID或组ID或节点ID。可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。约束限制:

  • 当获取的实例类型是集群,如果获取的是shard组或者config组的参数模板,传值为组ID。如果获取的是mongos节点的参数模板,传值为节点ID。
  • 当获取的实例类型是副本集或单节点,传值为实例ID。
  • 当获取的实例类型是只读节点,传值为节点ID。

取值范围:

不涉及。

默认取值:

不涉及。

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。

约束限制:

取值必须为数字,不能为负数。

取值范围:

不涉及。

默认取值:

0。

limit

Integer

参数解释:

查询个数上限值。不传该参数时,默认查询前100条信息。

约束限制:

不涉及。

取值范围:

1~100。

默认取值:

100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token。请参考认证鉴权

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

histories

Array of objects

参数解释:

实例参数的修改历史列表。详情请参见表5

取值范围:

不涉及。

表5 ConfigurationModifyHistoryInfo

参数

参数类型

描述

parameter_name

String

参数解释:

参数名称。

取值范围:

不涉及。

old_value

String

参数解释:

修改前的值。

取值范围:

不涉及。

new_value

String

参数解释:

修改后的值。

取值范围:

不涉及。

update_result

String

参数解释:

更新结果。

取值范围:

不涉及。

applied

Boolean

参数解释:

是否被应用。

取值范围:

  • true: 已被应用。
  • false: 未被应用。

updated_at

String

参数解释:

修改时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

取值范围:

不涉及。

applied_at

String

参数解释:

应用时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

取值范围:

不涉及。

请求示例

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

响应示例

{ 
  "histories" : [ { 
    "parameter_name" : "rateLimit.mbps", 
    "old_value" : "500", 
    "new_value" : "350", 
    "update_result" : "SUCCESS", 
    "applied" : true, 
    "updated_at" : "2022-06-07T09:25:45+0000", 
    "applied_at" : "2022-06-07T09:25:45+0000" 
  } ] 
}

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码