DescribeDBInstanceParamTpl

Baixar

Modo Foco

Tamanho da Fonte

Última atualização: 2026-05-25 17:15:56

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to query ALL MongoDB database parameter templates under the current account.
Description: The DescribeDBInstanceParamTpl API is in public beta. During this period, this API is only applicable to beta test participants.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeDBInstanceParamTpl.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	No	String	Common Params. This parameter is not required for this API.
TplIds.N	No	Array of String	Parameter template ID. Use the DescribeDBInstanceParamTpl interface to obtain template ID.
TplNames.N	No	Array of String	Specifies the template name for query.
MongoVersion.N	No	Array of String	Specifies the database version number of the parameter template to query. For supported versions, use the DescribeSpecInfo API. - MONGO_36_WT: Version of the MongoDB 3.6 WiredTiger storage engine. - MONGO_40_WT: Version of the MongoDB 4.0 WiredTiger storage engine. - MONGO_42_WT: Version of the MongoDB 4.2 WiredTiger storage engine. - MONGO_44_WT: Version of the MongoDB 4.4 WiredTiger storage engine. - MONGO_50_WT: Version of the MongoDB 5.0 WiredTiger storage engine. - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. - MONGO_80_WT: version of the MongoDB 8.0 WiredTiger storage engine.
TplType	No	String	Specifies the template type for query. -DEFAULT: System default template. -CUSTOMIZE: custom template.

3. Output Parameters

Parameter Name	Type	Description
ParamTpls	Array of ParamTpl	Parameter template list info.
TotalCount	Integer	Total number of parameter templates.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query parameter template by template ID

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceParamTpl
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameter	Parameter error
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.

Ajuda e Suporte

Esta página foi útil?

Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.

comentários

tencent cloud

TencentDB for MongoDB