tencent cloud

All product documents
TencentDB for PostgreSQL
DocumentationTencentDB for PostgreSQLAPI DocumentationParameter Management APIsDescribeParameterTemplates
DescribeParameterTemplates
Download PDF
Last updated: 2024-06-17 14:26:06
DescribeParameterTemplates
Last updated: 2024-06-17 14:26:06
Download PDF

1. API Description

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

This API is used to query the list of parameter templates.

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: DescribeParameterTemplates.
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.
Filters.N No Array of Filter Filter conditions. Valid values: TemplateName, TemplateId, DBMajorVersion, DBEngine.
Limit No Integer The maximum number of results returned per page. Value range: 0-100. Default: 20.
Offset No Integer Data offset
OrderBy No String Sorting metric. Valid values: CreateTime, TemplateName, DBMajorVersion.
OrderByType No String Sorting order. Valid values: asc (ascending order),desc (descending order).

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of eligible parameter templates
ParameterTemplateSet Array of ParameterTemplate Parameter template list
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 Information of a Parameter Template

None

Input Example

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

{
    "Filters": [
        {
            "Name": "TemplateName",
            "Values": [
                "test"
            ]
        }
    ],
    "Limit": 0,
    "Offset": 10,
    "OrderBy": "CreateTime",
    "OrderByType": "desc"
}

Output Example

{
    "Response": {
        "ParameterTemplateSet": [
            {
                "DBEngine": "postgresql",
                "DBMajorVersion": "13",
                "TemplateDescription": "test1",
                "TemplateId": "674538e8-4a03-5103-896c-9785c960bf02",
                "TemplateName": "test1"
            },
            {
                "DBEngine": "postgresql",
                "DBMajorVersion": "13",
                "TemplateDescription": "test2",
                "TemplateId": "423984bb-97fe-5693-a74f-63cc8dfb6c5d",
                "TemplateName": "test2"
            }
        ],
        "RequestId": "6224e7ed-d7d8-494c-835f-e1612345383f",
        "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.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon