云数据库 MongoDB 查询实例参数模板列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeDBInstanceParamTpl )用于查询当前账号下所有MongoDB数据库参数模板
说明：DescribeDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstanceParamTpl。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	否	String	公共参数，本接口不需要传递此参数。
TplIds.N	否	Array of String	参数模板 ID 查询条件。示例值：["tpl-sdjf143qu"]
TplNames.N	否	Array of String	模板名称，查询条件。示例值：["test"]
MongoVersion.N	否	Array of String	根据版本号插叙参数模板，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。参数与版本对应关系是：MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。示例值：["MONGO_42_WT"]
TplType	否	String	根据模板类型查询参数模板，支持DEFAULT（默认模板）和CUSTOMIZE（自定义模板）两种。示例值：CUSTOMIZE

3. 输出参数

参数名称	类型	描述
ParamTpls	Array of ParamTpl	参数模板列表信息。注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	参数模板总数。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据模板ID查询参数模板

输入示例

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

{
    "TplIds": [
        "tpl-eykkk2khs"
    ]
}

输出示例

{
    "Response": {
        "ParamTpls": [
            {
                "ClusterType": "REPLSET",
                "MongoVersion": "MONGO_42_WT",
                "TplDesc": "System predefined, forbid modify and delete.",
                "TplId": "tpl-eykkk2khs",
                "TplName": "default parameter template",
                "TplType": "DEFAULT"
            }
        ],
        "RequestId": "7878d7d7-8c80-4050-93a1-5e1785effd1a",
        "TotalCount": 1
    }
}

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	当前子账号无权执行该操作。