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 parametersDescribeApplyParameterTemplate
Copy page
Download PDFManaging parameters
DescribeApplyParameterTemplate
Copy pageDownload PDFDescribeApplyParameterTemplate
Call the DescribeApplyParameterTemplate API to query the parameter changes after applying the parameter template (only query, not actually apply).
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 | Required? | Example | Description |
Parameter | Type | Required? | Example | Description |
InstanceId | String | Yes | postgres-a3e7eb2f**** | Instance ID. |
TemplateId | String | Yes | postgresql-11b3a53c7d97**** | Parameter template ID. |
Response parameter
Parameter | Type | Example | Description |
Parameter | Type | Example | Description |
InstanceId | String | postgres-a3e7eb2f**** | Instance ID. |
Parameters | Refer to the Sample response. | Changes to the instance's parameters after applying the specified parameter template. tip This field is not returned if applying the specified parameter template does not change the instance parameters. | |
TemplateId | String | postgresql-11b3a53c7d97**** | Parameter template ID. |
InstanceParamChgObject
Parameter | Type | Example | Description |
Parameter | Type | Example | Description |
Name | String | auto_explain.log_buffers | Parameter name. |
NewValue | String | on | Running value defined for the parameter in the parameter template. |
OldValue | String | off | Running value of this parameter in the current instance. |
Restart | Boolean | false | Whether the parameter modification requires an instance restart. Values:
|
Example
Sample request
POST /?Action=DescribeApplyParameterTemplate&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****
{
"InstanceId": "postgres-a3e7eb2f****",
"TemplateId": "postgresql-11b3a53c7d97****"
}
Sample response
{
"ResponseMetadata": {
"RequestId": "202505071634404CE78800F77F017F85CE-ac4293",
"Action": "DescribeApplyParameterTemplate",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijing"
},
"Result": {
"InstanceId": "postgres-a3e7eb2f****",
"Parameters": [
{
"Name": "auto_explain.log_buffers",
"NewValue": "on",
"OldValue": "off",
"Restart": false
},
{
"Name": "auto_explain.log_analyze",
"NewValue": "on",
"OldValue": "off",
"Restart": false
}
],
"TemplateId": "postgresql-11b3a53c7d97****"
}
}
Last updated: 2026.03.31 10:45:19
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
