文档中心

文档数据库 MongoDB 版

参数管理

DescribeDBInstanceParametersLog

调用 DescribeDBInstanceParametersLog 接口查询目标 MongoDB 实例在指定时间内的参数修改历史。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

InstanceId String 必选示例值：mongo-replica-a1f25ba5****

实例 ID。

说明

您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

StartTime String 必选示例值：2024-04-12T17:37:00Z

查询开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC+8）。

EndTime String 必选示例值：2024-04-12T17:38:00Z

查询结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC+8）。

说明

查询结束时间需晚于查询开始时间。

PageNumber Integer 必选示例值：1

参数修改历史信息的列表页码。取值为不超过 Integer 数据类型的最大值，起始值为 1。

PageSize Integer 必选示例值：10

每页记录数，取值范围为 1~1000，默认值为 10。

返回参数

Total Integer 示例值：1

所有存在修改历史的参数数量。

ParameterChangeLog Object[] 示例值：

参数修改历史的信息列表。

ModifyTime String 示例值：2024-04-12 17:37:30

目标参数被修改的时间点（本地时间）。

NewParameterValue String 示例值：600001

修改后的参数值。

OldParameterValue String 示例值：600000

修改前的参数值。

ParameterName String 示例值：cursorTimeoutMillis

目标参数的名称。

ParameterRole String 示例值：Node

目标参数所属的节点类型，取值范围如下：

Node：副本集实例节点。

Shard：分片集群实例中的 Shard 节点。

ConfigServer：分片集群实例中的 ConfigServer 节点。

Mongos：分片集群实例中的 Mongos 节点。

说明

您可以调用 DescribeDBInstanceParameters接口查询目标实例支持的参数详情，包括参数所属的节点类型。

ParameterStatus String 示例值：Applied

新参数值是否生效。取值范围如下：

Applied：已生效。

Invalid：未生效。

示例

请求示例

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceParametersLog&Version=2022-01-01 HTTP/1.1​
Host: mongodb.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "InstanceId": "mongo-replica-55d59354****",​
    "StartTime": "2024-04-12T17:37:00Z",​
    "EndTime": "2024-04-12T17:38:00Z",​
    "PageSize": 10,​
    "PageNumber": 1​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2022052716480301022508219902F002F0",​
        "Action": "DescribeDBInstanceParametersLog",​
        "Version": "2022-01-01",​
        "Service": "mongodb",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "ParameterChangeLog": [​
            {​
                "ModifyTime": "2024-04-12 17:37:30",​
                "NewParameterValue": "600001",​
                "OldParameterValue": "600001",​
                "ParameterName": "cursorTimeoutMillis",​
                "ParameterRole": "Node",​
                "ParameterStatus": "Applied"​
            }​
        ],​
        "Total": 1​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.06.17 16:53:14

这个页面对您有帮助吗？

有用

无用