RDS for PostgreSQL
RDS for PostgreSQL
RDS for PostgreSQL
Document
What's new
Product announcement
Overview
Billing
Quick start
User guide
Managing instances
Modifying the specification
Managing tags
Managing connections
Connecting to an instance
Managing connection endpoints
Service availability
Managing accounts
Managing databases
Managing schemas
Monitoring and alerts
Backup recovery
Data backup
Managing logs
Data security
Managing the allowlist (new version)
Configuring SSL encryption
Configuring parameters
Operation and maintenance events
Task center
Extensions
API reference
V2(2022-01-01)
Managing instances
Managing accounts
Managing schemas
Managing connections
Managing parameters
Backup and recovery
Managing logs
Event management
Data security
Task management
SDK reference
Developer tool
Best practices
Performance document
FAQs
Terms
- Documentation
RDS for PostgreSQL API referenceV2(2022-01-01)Managing parametersCreateParameterTemplate
Copy page
Download PDFManaging parameters
CreateParameterTemplate
Copy pageDownload PDFCreateParameterTemplate
Call the CreateParameterTemplate API to create a parameter template.
Request type
Synchronous request.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Parameter | Type | Is it required? | Example | Description |
Parameter | Type | Is it required? | Example | Description |
TemplateName | String | Yes | Parameter template_test | Name of the parameter template. The template name should satisfy the following rules:
|
TemplateType | String | Yes | PostgreSQL | Parameter template type. The current value can only be PostgreSQL. |
TemplateParams | Yes | Refer to the request example. | Parameters configuration in the parameter template. | |
TemplateTypeVersion | String | Yes | PostgreSQL_12 | Compatible version. Values:
|
TemplateDesc | String | No | This is a description of the parameter. | Description of the template, facilitating subsequent template application and management. It supports up to 200 characters. |
ParameterObject
Parameter | Type | Required? | Example | Description |
Parameter | Type | Required? | Example | Description |
Name | String | Yes | auto_explain.log_analyze | Parameter name. |
Value | String | Yes | off | Parameter value. Refers specifically to the current instance running value. |
Response parameter
Parameter | Type | Example | Description |
Parameter | Type | Example | Description |
TemplateId | String | postgresql-6d57281c3313**** | ID of the parameter template. |
Example
Sample request
POST /?Action=CreateParameterTemplate&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"TemplateName": "参数模板_测试",
"TemplateType": "PostgreSQL",
"TemplateTypeVersion": "PostgreSQL_12",
"TemplateParams": [
{
"Name": "auto_explain.log_analyze",
"Value": "off"
}
]
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20250507154042DB11BFB3A01D08296D2D-91d4e7",
"Action": "CreateParameterTemplate",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijijng"
},
"Result": {
"TemplateId": "postgresql-6d57281c3313****"
}
}
Last updated: 2026.10.16 14:25:12
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
