文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/参数配置/查询指定实例参数的修改历史
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询指定实例参数的修改历史

接口说明

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

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 Query参数

参数

参数类型

是否必选

描述

offset

Integer

否

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 取值必须为数字，不能为负数。

limit

Integer

否

查询个数上限值。

  • 取值范围: 1~100。
  • 不传该参数时，默认查询前100条信息。

entity_id

String

是

实例ID或组ID或节点ID。可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。

  • 当获取的实例类型是集群，如果获取的是shard组或者config组的参数模板，传值为组ID。如果获取的是mongos节点的参数模板，传值为节点ID。
  • 当获取的实例类型是副本集，传值为实例ID。如果获取的是readonly节点的参数模板，传值为节点ID。
  • 请求示例

    无。

响应参数

  • 参数说明
    表4 响应Body参数

    参数

    参数类型

    说明

    histories

    Array of 表5 objects

    实例参数的修改历史列表。

    表5 ConfigurationModifyHistoryInfo

    参数

    参数类型

    说明

    parameter_name

    String

    参数名称。

    old_value

    String

    修改前的值。

    new_value

    String

    修改后的值。

    update_result

    String

    更新结果。

    applied

    Boolean

    是否被应用。

    updated_at

    String

    修改时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。

    applied_at

    String

    应用时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。

  • 响应示例 
    { 
  "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" 
  } ] 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：参数配置