云数据库 PostgreSQL 查询参数模板列表-参数管理相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口 (DescribeParameterTemplates) 用于查询参数模板列表。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeParameterTemplates。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤条件，目前支持的过滤条件有：TemplateName, TemplateId，DBMajorVersion，DBEngine 示例值：[ { "Values": [ "postgres-jdlmoll9" ], "Name": "db-instance-id" } ]
Limit	否	Integer	每页显示数量，[0，100]，默认 20 示例值：20
Offset	否	Integer	数据偏移量示例值：10
OrderBy	否	String	排序指标，枚举值，支持：CreateTime，TemplateName，DBMajorVersion 示例值：CreateTime
OrderByType	否	String	排序方式，枚举值，支持：asc（升序），desc（降序）示例值：desc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合查询条件的参数模板总数示例值：20
ParameterTemplateSet	Array of ParameterTemplate	参数模板列表示例值：[ { "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	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询参数模板信息

无

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParameterTemplates
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.CamDeniedError	当前操作被限制。

查询参数模板列表

本页目录：