DescribeInstanceParams

Last updated: 2025-12-03 10:42:06

DescribeInstanceParams

Last updated: 2025-12-03 10:42:06

1. API Description

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

This API is used to query the list of parameters that can be modified for the current instance.

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: DescribeInstanceParams.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Specifies the instance ID for querying the parameter list. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console and copy the instance ID from the instance list.

3. Output Parameters

Parameter Name	Type	Description
InstanceEnumParam	Array of InstanceEnumParam	Collection of parameters whose values are of the Enum type.
InstanceIntegerParam	Array of InstanceIntegerParam	Collection of parameters whose values are of the Integer type.
InstanceTextParam	Array of InstanceTextParam	Collection of parameters whose values are of the Text type.
InstanceMultiParam	Array of InstanceMultiParam	Collection of parameters whose values are of different types.
TotalCount	Integer	Number of modifiable parameters supported by the current instance.
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 InstanceEnumParam

This example shows you how to call this API to obtain the list of configurable parameters for a TencentDB for MongoDB instance.

Input Example

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

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

Output Example

{
    "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. 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
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameter.CurrentInstanceNotSupportModifyParams	The instance does not support parameter setting.
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.NotFoundInstance	The instance was not found.
ResourceNotFound	The resource does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud