1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
本接口（DescribeParameterTemplateAttributes）用于查询某个参数模板的具体内容，包括基本信息和参数信息。
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeParameterTemplateAttributes。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TemplateId | 是 | String | 参数模板ID 示例值：423984bb-97fe-5693-a74f-63cc8dfb6c5d |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TemplateId | String | 参数模板ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：423984bb-97fe-5693-a74f-63cc8dfb6c5d |
| TotalCount | Integer | 参数模板包含的参数个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ParamInfoSet | Array of ParamInfo | 参数模板包含的参数信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "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": "此参数决定记录到日志的信息，不允许设置为minimal", "ParamDescriptionEN": "Set the level of information written to the WAL.", "ParamValueType": "enum", "SpecRelated": false, "StandbyRelated": 0, "Unit": "" } ] |
| TemplateName | String | 参数模板名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
| DBMajorVersion | String | 参数模板适用的数据库版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：13 |
| DBEngine | String | 参数模板适用的数据库引擎 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgresql |
| TemplateDescription | String | 参数模板描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：use to test |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询参数模板详情
无
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParameterTemplateAttributes
<公共请求参数>
{
"TemplateId": "c0456ace-31d1-54b1-a270-befa6bf960a5"
}输出示例
{
"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": "此参数决定记录到日志的信息，不允许设置为minimal",
"ParamDescriptionEN": "Set the level of information written to the WAL.",
"ParamValueType": "enum",
"VersionRelationSet": [],
"SpecRelated": false,
"StandbyRelated": 0,
"Unit": "",
"SpecRelationSet": []
},
{
"Advanced": false,
"ClassificationCN": "资源使用",
"ClassificationEN": "Resource Usage",
"CurrentValue": "12",
"DefaultValue": "8",
"EnumValue": null,
"ID": 755,
"LastModifyTime": "",
"Max": 262143,
"Min": 0,
"Name": "max_worker_processes",
"NeedReboot": true,
"ParamDescriptionCH": "系统能够支持的后台进程的最大数量",
"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. 开发者资源
腾讯云 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
