tencent cloud

1. API Description

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

This API is used to query all parameters supported by a database version and engine.

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

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.

3. Output Parameters

4. Example

Example1 Querying Information of All Parameters That Can Be Added for a Parameter Template

None

Input Example

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

{
    "DBMajorVersion": "13",
    "DBEngine": "postgresql"
}

Output Example

{
    "Response": {
        "RequestId": "b6cf4dfc-09ce-4ee4-9c3e-0979e105bb4d",
        "TotalCount": 4,
        "ParamInfoSet": [
            {
                "Advanced": false,
                "ClassificationCN": "Query Optimization",
                "ClassificationEN": "Query Tuning",
                "CurrentValue": "",
                "DefaultValue": "500000",
                "EnumValue": [],
                "ID": 14092,
                "LastModifyTime": "",
                "Max": 123124123,
                "Min": -1,
                "Name": "jit_inline_above_cost",
                "NeedReboot": false,
                "ParamDescriptionCH": "This example shows you how to set the query cost threshold for JIT compilation to attempt inlining functions and operators. If the query cost exceeds this value, JIT compilation will try to inline",
                "ParamDescriptionEN": "Perform JIT inlining if query is more expensive.-1 disables inlining.",
                "ParamValueType": "real",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "AUTOVACUUM",
                "ClassificationEN": "Autovacuum",
                "CurrentValue": "",
                "DefaultValue": "400000000",
                "EnumValue": [],
                "ID": 14131,
                "LastModifyTime": "",
                "Max": 2000000000,
                "Min": 10000,
                "Name": "autovacuum_multixact_freeze_max_age",
                "NeedReboot": true,
                "ParamDescriptionCH": "This example shows you how to sets the maximum age in multi-transaction scenarios on a table. Reaching this threshold will trigger the Autovacuum Process to avoid wraparound.",
                "ParamDescriptionEN": "Multixact age at which to autovacuum a table to prevent multixact wraparound.",
                "ParamValueType": "integer",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "Client connection defaults",
                "ClassificationEN": "Client connection defaults",
                "CurrentValue": "",
                "DefaultValue": "\"$user\", public",
                "EnumValue": [],
                "ID": 14173,
                "LastModifyTime": "",
                "Max": 0,
                "Min": 0,
                "Name": "search_path",
                "NeedReboot": false,
                "ParamDescriptionCH": "The default search_path",
                "ParamDescriptionEN": "Sets the schema search order for names that are not schema-qualified.",
                "ParamValueType": "string",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "Client connection defaults",
                "ClassificationEN": "Client connection defaults",
                "CurrentValue": "",
                "DefaultValue": "150000000",
                "EnumValue": [],
                "ID": 14175,
                "LastModifyTime": "",
                "Max": 2000000000,
                "Min": 0,
                "Name": "vacuum_multixact_freeze_table_age",
                "NeedReboot": false,
                "ParamDescriptionCH": "When the pg_class.relfrozenxid field of a table reaches the age specified by this setting, VACUUM will perform a full table scan. An aggressive scan, unlike a regular VACUUM, accesses every page that may contain unfrozen XIDs or MXIDs, not just those that might contain dead tuples",
                "ParamDescriptionEN": "Multixact age at which VACUUM should scan whole table to freeze tuples.",
                "ParamValueType": "integer",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            }
        ]
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.