云数据库 MongoDB 参数模板详情-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeDBInstanceParamTplDetail )用于查询MongoDB云数据库实例的参数模板详情。
说明：DescribeDBInstanceParamTplDetail API正在公测中，在此期间，该接口仅对公测用户开放

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstanceParamTplDetail。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	否	String	公共参数，本接口不需要传递此参数。
TplId	是	String	参数模板 ID。示例值：tpl-sdvj2jh4k
ParamName	否	String	参数名称，传入该值，则只会获取该字段的参数详情。为空时，返回全部参数。示例值：operationProfiling.mode

3. 输出参数

参数名称	类型	描述
InstanceEnumParams	Array of InstanceEnumParam	枚举类参数详情列表。注意：此字段可能返回 null，表示取不到有效值。
InstanceIntegerParams	Array of InstanceIntegerParam	整形参数详情列表。注意：此字段可能返回 null，表示取不到有效值。
InstanceTextParams	Array of InstanceTextParam	文本参数详情列表。注意：此字段可能返回 null，表示取不到有效值。
InstanceMultiParams	Array of InstanceMultiParam	多值参数详情列表。注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	参数总个数。注意：此字段可能返回 null，表示取不到有效值。
MongoVersion	String	模板适配实例版本。注意：此字段可能返回 null，表示取不到有效值。示例值：MONGO_50_WT
ClusterType	String	模板适配集群类型，副本集或分片。。注意：此字段可能返回 null，表示取不到有效值。示例值：SHARD
TplName	String	参数模板名称。注意：此字段可能返回 null，表示取不到有效值。示例值：test
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询参数模板详情

输入示例

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

{
    "TplId": "tpl-2284g3nmw"
}

输出示例

{
    "Response": {
        "ClusterType": "REPLSET",
        "InstanceEnumParams": [
            {
                "CurrentValue": "off",
                "DefaultValue": "off",
                "EnumValue": [
                    "off",
                    "slowOp",
                    "all"
                ],
                "NeedRestart": "0",
                "ParamName": "operationProfiling.mode",
                "Status": 1,
                "Tips": [
                    "",
                    "specifies which operations should be profiled."
                ],
                "ValueType": "enum"
            },
            {
                "CurrentValue": "snappy",
                "DefaultValue": "snappy",
                "EnumValue": [
                    "snappy",
                    "zlib",
                    "zstd",
                    "none"
                ],
                "NeedRestart": "1",
                "ParamName": "storage.wiredTiger.collectionConfig.blockCompressor",
                "Status": 1,
                "Tips": [
                    "",
                    "you can uses zstd for journal compression and data compression."
                ],
                "ValueType": "enum"
            }
        ],
        "InstanceIntegerParams": [
            {
                "CurrentValue": "100",
                "DefaultValue": "100",
                "Max": "65536",
                "Min": "0",
                "NeedRestart": "0",
                "ParamName": "operation.profiling.slowOpThresholdMs",
                "Status": 1,
                "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": 1,
                "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.internalQueryMaxBlockingSortMemoryUsageBytes",
                "Status": 1,
                "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": 1,
                "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": 1,
                "Tips": [
                    "",
                    "specifies the lifetime of multi-document transactions."
                ],
                "Unit": "",
                "ValueType": "integer"
            }
        ],
        "InstanceMultiParams": [],
        "InstanceTextParams": [],
        "MongoVersion": "MONGO_50_WT",
        "RequestId": "5dedc31c-ee80-4a12-9ed3-6003504b5a57",
        "TotalCount": 7,
        "TplName": "demo"
    }
}

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. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。