DescribeDBInstanceParameters--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceParameters

最近更新时间：2024.12.12 21:46:13首次发布时间：2022.08.04 11:30:28

调用 DescribeDBInstanceParameters 接口查询目标 MongoDB 实例支持的参数列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-55d59354****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
ParameterRole	String	否	Node	目标参数所属的节点类型，取值范围如下： `Node`：副本集实例节点。 `Shard`：分片集群实例中的 Shard 节点。 `ConfigServer`：分片集群实例中的 ConfigServer 节点。 `Mongos`：分片集群实例中的 Mongos 节点。说明您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情，包括参数所属的节点类型。当传入的 `InstanceId` 为副本集实例 ID 时，`ParameterRole` 可留空或设置为 `Node`。当传入的 `InstanceId` 为分片集群实例 ID 时，若`ParameterRole` 不填，默认会返回分片集群中所有类型节点的参数。
ParameterNames	String	否	connPoolMaxConnsPerHost	需要查找的参数名称。说明支持模糊查询，不区分大小写。例如，您可以传入 `pool` 来查询所有名称中包含 `pool` 的参数详情。若该参数留空，默认查询当前实例中所有参数的详情。

返回参数

参数	类型	示例值	描述
InstanceId	String	mongo-replica-55d59354****	实例 ID。
DBEngine	String	MongoDB	数据库引擎。取值固定为 `MongoDB`。
DBEngineVersion	String	MongoDB_4_0	数据库引擎版本。
Total	String	1	符合查询要求的参数个数。
InstanceParameters	Object[]		符合查询要求的所有参数详情列表。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Host: mongodb.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****",
    "ParameterNames": "pool"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052716480301022508219902F0****",
        "Action": "DescribeDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBEngine": "MongoDB",
        "DBEngineVersion": "MongoDB_4_0",
        "InstanceId": "mongo-replica-55d59354****",
        "InstanceParameters": [
            {
                "CheckingCode": "200 - 2000",
                "ForceModify": true,
                "ForceRestart": true,
                "ParameterDefaultValue": "600",
                "ParameterDescription": "表示当前实例与其他mongod实例通信的连接池的最大连接数",
                "ParameterNames": "connPoolMaxConnsPerHost",
                "ParameterRole": "Node",
                "ParameterType": "Integer",
                "ParameterValue": "601"
            }
        ],
        "Total": "1"
    }
}

错误码

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