获取当前实例可修改的参数列表

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

本接口（DescribeInstanceParams）用于查询当前实例可修改的参数列表。

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

4. 示例

示例1 InstanceEnumParam

用户请求该接口获取其mongoDB实例可配置的参数列表；

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceParams
<公共请求参数>

{
    "InstanceId": "cmgo-9d0p****"
}

输出示例

{
    "Response": {
        "InstanceEnumParam": [
            {
                "CurrentValue": "off",
                "DefaultValue": "off",
                "EnumValue": [
                    "off",
                    "slowOp",
                    "all"
                ],
                "NeedRestart": "0",
                "ParamName": "operationProfiling.mode",
                "Status": 0,
                "Tips": [
                    "",
                    "specifies which operations should be profiled."
                ],
                "ValueType": "enum"
            },
            {
                "CurrentValue": "true",
                "DefaultValue": "true",
                "EnumValue": [
                    "true",
                    "false"
                ],
                "NeedRestart": "0",
                "ParamName": "setParameter.failIndexKeyTooLong",
                "Status": 0,
                "Tips": [
                    "",
                    "index key length limit applies."
                ],
                "ValueType": "enum"
            }
        ],
        "InstanceIntegerParam": [
            {
                "CurrentValue": "100",
                "DefaultValue": "100",
                "Max": "65536",
                "Min": "0",
                "NeedRestart": "0",
                "ParamName": "operation.profiling.slowOpThresholdMs",
                "Status": 0,
                "Tips": [
                    "",
                    "the slow operation time threshold, in milliseconds."
                ],
                "Unit": "",
                "ValueType": "integer"
            },
            {
                "CurrentValue": "600000",
                "DefaultValue": "600000",
                "Max": "2147483647",
                "Min": "1",
                "NeedRestart": "0",
                "ParamName": "setParameter.cursorTimeoutMillis",
                "Status": 0,
                "Tips": [
                    "",
                    "sets the expiration threshold in milliseconds for idle cursors before MongoDB removes them."
                ],
                "Unit": "",
                "ValueType": "integer"
            },
            {
                "CurrentValue": "33554432",
                "DefaultValue": "33554432",
                "Max": "268435456",
                "Min": "33554432",
                "NeedRestart": "0",
                "ParamName": "setParameter.internalQueryExecMaxBlockingSortBytes",
                "Status": 0,
                "Tips": [
                    "",
                    "internal query exec max blocking sort bytes."
                ],
                "Unit": "",
                "ValueType": "integer"
            },
            {
                "CurrentValue": "5",
                "DefaultValue": "5",
                "Max": "60",
                "Min": "0",
                "NeedRestart": "0",
                "ParamName": "setParameter.maxTransactionLockRequestTimeoutMillis",
                "Status": 0,
                "Tips": [
                    "",
                    "the maximum amount of time in milliseconds that multi-document transactions should wait to acquire locks required by the operations in the transaction."
                ],
                "Unit": "",
                "ValueType": "integer"
            },
            {
                "CurrentValue": "60",
                "DefaultValue": "60",
                "Max": "300",
                "Min": "5",
                "NeedRestart": "0",
                "ParamName": "setParameter.transactionLifetimeLimitSeconds",
                "Status": 0,
                "Tips": [
                    "",
                    "specifies the lifetime of multi-document transactions."
                ],
                "Unit": "",
                "ValueType": "integer"
            }
        ],
        "InstanceMultiParam": [],
        "InstanceTextParam": [],
        "RequestId": "c07728e2-6747-4b0f-bcc9-e022036d5e28",
        "TotalCount": 7
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。