tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeParameterTemplateAttributes

Last updated: 2024-06-17 14:26:06

    1. API Description

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

    This API is used to query the details of a parameter template, including basic information and parameter information.

    A maximum of 1000 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: DescribeParameterTemplateAttributes.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    TemplateId Yes String Parameter template ID

    3. Output Parameters

    Parameter Name Type Description
    TemplateId String Parameter template ID
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Number of parameters contained in the parameter template
    Note: This field may return null, indicating that no valid values can be obtained.
    ParamInfoSet Array of ParamInfo Parameter information contained in the parameter template
    Note: This field may return null, indicating that no valid values can be obtained.
    TemplateName String Parameter template name
    Note: This field may return null, indicating that no valid values can be obtained.
    DBMajorVersion String Database version applicable to a parameter template
    Note: This field may return null, indicating that no valid values can be obtained.
    DBEngine String Database engine applicable to a parameter template
    Note: This field may return null, indicating that no valid values can be obtained.
    TemplateDescription String Parameter template description
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Querying Details of a Parameter Template

    None

    Input Example

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

{
    "TemplateId": "c0456ace-31d1-54b1-a270-befa6bf960a5"
}

    Output Example

    {
    "Response": {
        "DBEngine": "postgresql",
        "DBMajorVersion": "12",
        "ParamInfoSet": [
            {
                "Advanced": false,
                "ClassificationCN": "WAL",
                "ClassificationEN": "Write-Ahead Log",
                "CurrentValue": "logical",
                "DefaultValue": "replica",
                "EnumValue": [
                    "replica",
                    "logical"
                ],
                "ID": 854,
                "LastModifyTime": "",
                "Max": 0,
                "Min": 0,
                "Name": "wal_level",
                "NeedReboot": true,
                "ParamDescriptionCH": "This parameter determines the information recorded in the log, setting it to minimal is not allowed",
                "ParamDescriptionEN": "Set the level of information written to the WAL.",
                "ParamValueType": "enum",
                "VersionRelationSet": [],
                "SpecRelated": false,
                "StandbyRelated": 0,
                "Unit": "",
                "SpecRelationSet": []
            },
            {
                "Advanced": false,
                "ClassificationCN": "Resource Usage",
                "ClassificationEN": "Resource Usage",
                "CurrentValue": "12",
                "DefaultValue": "8",
                "EnumValue": null,
                "ID": 755,
                "LastModifyTime": "",
                "Max": 262143,
                "Min": 0,
                "Name": "max_worker_processes",
                "NeedReboot": true,
                "ParamDescriptionCH": "The maximum number of background processes that the system can support",
                "ParamDescriptionEN": "Maximum number of concurrent worker processes.",
                "ParamValueType": "integer",
                "VersionRelationSet": [
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 300,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 400,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 400,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 500,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 900,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 900,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 900,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 300,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 400,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 500,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 500,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 1300,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    },
                    {
                        "DBKernelVersion": "",
                        "EnumValue": null,
                        "Max": 1300,
                        "Min": 4,
                        "Name": "max_worker_processes",
                        "Unit": "null",
                        "Value": "8"
                    }
                ],
                "SpecRelated": true,
                "StandbyRelated": 1,
                "Unit": "",
                "SpecRelationSet": []
            }
        ],
        "RequestId": "e4f0f472-8bef-4404-b3fa-57ed6b6378b8",
        "TemplateDescription": "test-modify",
        "TemplateId": "c0456ace-31d1-54b1-a270-befa6bf960a5",
        "TemplateName": "test-modify_1",
        "TotalCount": 2
    }
}

    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
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy