DescribeParameterTemplateAttributes

Unduh

Mode fokus

Ukuran font

Terakhir diperbarui: 2026-05-21 10:43:26

1. API Description

Domain name for API request: postgres.intl.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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TemplateId	Yes	String	Specifies the parameter template ID, which can be obtained through the api DescribeParameterTemplates.

3. Output Parameters

Parameter Name	Type	Description
TemplateId	String	Specifies the parameter template ID.
TotalCount	Integer	Specifies the number of parameters in the parameter template.
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
DBMajorVersion	String	Specifies the database version the parameter template applies to.
DBEngine	String	Specifies the database engine the parameter template applies to.
TemplateDescription	String	Parameter template description
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.intl.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,
"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": []
            }
        ],
        "RequestId": "e4f0f472-8bef-4404-b3fa-57ed6b6378b8",
        "TemplateDescription": "test-modify",
        "TemplateId": "c0456ace-31d1-54b1-a270-befa6bf960a5",
        "TemplateName": "test-modify_1",
        "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
FailedOperation.FailedOperationError	Operation failed. Please try again later.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

TencentDB for PostgreSQL