tencent cloud

Feedback

DescribeInstanceParams

Last updated: 2022-04-20 15:20:57

1. API Description

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

This API is used to query the modifiable parameter list of an 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 Instance ID

3. Output Parameters

Parameter Name Type Description
InstanceEnumParam Array of InstanceEnumParam The collection of enum parameters
InstanceIntegerParam Array of InstanceIntegerParam The collection of integer parameters
InstanceTextParam Array of InstanceTextParam The collection of text parameters
InstanceMultiParam Array of InstanceMultiParam The collection of string parameters used to represent time ranges
TotalCount Integer The total number of modifiable parameters of the instance, such as 0
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 InstanceEnumParam

This example shows you how to query the modifiable parameter list of a MongoDB instance.

Input Example

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

{
    "InstanceId": "jyjcw8yv"
}

Output Example

{
  "Response": {
    "InstanceEnumParam": [
      {
        "Status": 1,
        "CurrentValue": "xx",
        "DefaultValue": "xx",
        "NeedRestart": "xx",
        "EnumValue": [
          "xx"
        ],
        "ParamName": "xx",
        "Tips": [
          "xx"
        ],
        "ValueType": "xx"
      }
    ],
    "InstanceTextParam": [
      {
        "Status": "xx",
        "CurrentValue": "xx",
        "DefaultValue": "xx",
        "NeedRestart": "xx",
        "ParamName": "xx",
        "Tips": [
          "xx"
        ],
        "TextValue": "xx",
        "ValueType": "xx"
      }
    ],
    "TotalCount": 1,
    "RequestId": "xx",
    "InstanceIntegerParam": [
      {
        "Status": 1,
        "CurrentValue": "xx",
        "Min": "xx",
        "Max": "xx",
        "DefaultValue": "xx",
        "NeedRestart": "xx",
        "ParamName": "xx",
        "Tips": [
          "xx"
        ],
        "ValueType": "xx",
        "Unit": "xx"
      }
    ],
    "InstanceMultiParam": [
      {
        "Status": 1,
        "CurrentValue": "xx",
        "DefaultValue": "xx",
        "NeedRestart": "xx",
        "EnumValue": [
          "xx"
        ],
        "ParamName": "xx",
        "Tips": [
          "xx"
        ],
        "ValueType": "xx"
      }
    ]
  }
}

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

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 subaccount has no permission to perform this operation.
InvalidParameterValue.NotFoundInstance The instance was not found.
ResourceNotFound The resource does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support